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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The name of this resource. Node pool names are formatted as |
↳ version |
string
Required. The Kubernetes version to run on this node pool (e.g. |
↳ config |
Google\Cloud\GkeMultiCloud\V1\AwsNodeConfig
Required. The configuration of the node pool. |
↳ 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 |
Google\Protobuf\Timestamp
Output only. The time at which this node pool was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time at which this node pool was last updated. |
↳ 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
| Returns | |
|---|---|
| Type | Description |
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
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getConfig
Required. The configuration of the node pool.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AwsNodeConfig|null | |
hasConfig
clearConfig
setConfig
Required. The configuration of the node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AwsNodeConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAutoscaling
Required. Autoscaler configuration for this node pool.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AwsNodePoolAutoscaling|null | |
hasAutoscaling
clearAutoscaling
setAutoscaling
Required. Autoscaler configuration for this node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AwsNodePoolAutoscaling
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSubnetId
Required. The subnet where the node pool node run.
| Returns | |
|---|---|
| Type | Description |
string | |
setSubnetId
Required. The subnet where the node pool node run.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The lifecycle state of the node pool.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The lifecycle state of the node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUid
Output only. A globally unique identifier for the node pool.
| Returns | |
|---|---|
| Type | Description |
string | |
setUid
Output only. A globally unique identifier for the node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReconciling
Output only. If set, there are currently changes in flight to the node pool.
| Returns | |
|---|---|
| Type | Description |
bool | |
setReconciling
Output only. If set, there are currently changes in flight to the node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The time at which this node pool was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which this node pool was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The time at which this node pool was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which this node pool was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMaxPodsConstraint
Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\MaxPodsConstraint|null | |
hasMaxPodsConstraint
clearMaxPodsConstraint
setMaxPodsConstraint
Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\MaxPodsConstraint
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getErrors
Output only. A set of errors found in the node pool.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setErrors
Output only. A set of errors found in the node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\GkeMultiCloud\V1\AwsNodePoolError>
|
| Returns | |
|---|---|
| Type | Description |
$this | |