Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class AwsNodePool.
An Anthos node pool running on AWS.
Generated from protobuf message google.cloud.gkemulticloud.v1.AwsNodePool
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
The name of this resource. Node pool names are formatted as projects/<project-number>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>
. For more details on Google Cloud resource names, see Resource Names
↳ version
string
Required. The Kubernetes version to run on this node pool (e.g. 1.19.10-gke.1000
). You can list all supported versions on a given Google Cloud region by calling GetAwsServerConfig
.
↳ config
↳ autoscaling
Google\Cloud\GkeMultiCloud\V1\AwsNodePoolAutoscaling
Required. Autoscaler configuration for this node pool.
↳ subnet_id
string
Required. The subnet where the node pool node run.
↳ state
int
Output only. The lifecycle state of the node pool.
↳ uid
string
Output only. A globally unique identifier for the node pool.
↳ reconciling
bool
Output only. If set, there are currently changes in flight to the node pool.
↳ create_time
↳ update_time
↳ etag
string
Allows clients to perform consistent read-modify-writes through optimistic concurrency control. Can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
↳ annotations
array| Google\Protobuf\Internal\MapField
Optional. Annotations on the node pool. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.
↳ max_pods_constraint
Google\Cloud\GkeMultiCloud\V1\MaxPodsConstraint
Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
↳ errors
array< Google\Cloud\GkeMultiCloud\V1\AwsNodePoolError
>
Output only. A set of errors found in the node pool.
getName
The name of this resource.
Node pool names are formatted as projects/<project-number>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>
.
For more details on Google Cloud resource names,
see Resource Names
string
setName
The name of this resource.
Node pool names are formatted as projects/<project-number>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>
.
For more details on Google Cloud resource names,
see Resource Names
var
string
$this
getVersion
Required. The Kubernetes version to run on this node pool (e.g.
1.19.10-gke.1000
).
You can list all supported versions on a given Google Cloud region by
calling GetAwsServerConfig
.
string
setVersion
Required. The Kubernetes version to run on this node pool (e.g.
1.19.10-gke.1000
).
You can list all supported versions on a given Google Cloud region by
calling GetAwsServerConfig
.
var
string
$this
getConfig
Required. The configuration of the node pool.
hasConfig
clearConfig
setConfig
Required. The configuration of the node pool.
$this
getAutoscaling
Required. Autoscaler configuration for this node pool.
hasAutoscaling
clearAutoscaling
setAutoscaling
Required. Autoscaler configuration for this node pool.
$this
getSubnetId
Required. The subnet where the node pool node run.
string
setSubnetId
Required. The subnet where the node pool node run.
var
string
$this
getState
Output only. The lifecycle state of the node pool.
int
setState
Output only. The lifecycle state of the node pool.
var
int
$this
getUid
Output only. A globally unique identifier for the node pool.
string
setUid
Output only. A globally unique identifier for the node pool.
var
string
$this
getReconciling
Output only. If set, there are currently changes in flight to the node pool.
bool
setReconciling
Output only. If set, there are currently changes in flight to the node pool.
var
bool
$this
getCreateTime
Output only. The time at which this node pool was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which this node pool was created.
$this
getUpdateTime
Output only. The time at which this node pool was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which this node pool was last updated.
$this
getEtag
Allows clients to perform consistent read-modify-writes through optimistic concurrency control.
Can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
string
setEtag
Allows clients to perform consistent read-modify-writes through optimistic concurrency control.
Can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
var
string
$this
getAnnotations
Optional. Annotations on the node pool.
This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.
setAnnotations
Optional. Annotations on the node pool.
This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.
$this
getMaxPodsConstraint
Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
hasMaxPodsConstraint
clearMaxPodsConstraint
setMaxPodsConstraint
Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
$this
getErrors
Output only. A set of errors found in the node pool.
setErrors
Output only. A set of errors found in the node pool.
$this
