Google Anthos Multi Cloud V1 Client - Class AwsNodePool (0.1.4)

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
NameDescription
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 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.

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

Generated from protobuf field string name = 1;

Returns
TypeDescription
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

Generated from protobuf field string name = 1;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field string version = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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.

Generated from protobuf field string version = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getConfig

Required. The configuration of the node pool.

Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsNodeConfig config = 28 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Google\Cloud\GkeMultiCloud\V1\AwsNodeConfig|null

hasConfig

clearConfig

setConfig

Required. The configuration of the node pool.

Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsNodeConfig config = 28 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var Google\Cloud\GkeMultiCloud\V1\AwsNodeConfig
Returns
TypeDescription
$this

getAutoscaling

Required. Autoscaler configuration for this node pool.

Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsNodePoolAutoscaling autoscaling = 25 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Google\Cloud\GkeMultiCloud\V1\AwsNodePoolAutoscaling|null

hasAutoscaling

clearAutoscaling

setAutoscaling

Required. Autoscaler configuration for this node pool.

Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsNodePoolAutoscaling autoscaling = 25 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var Google\Cloud\GkeMultiCloud\V1\AwsNodePoolAutoscaling
Returns
TypeDescription
$this

getSubnetId

Required. The subnet where the node pool node run.

Generated from protobuf field string subnet_id = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
string

setSubnetId

Required. The subnet where the node pool node run.

Generated from protobuf field string subnet_id = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. The lifecycle state of the node pool.

Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsNodePool.State state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

setState

Output only. The lifecycle state of the node pool.

Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsNodePool.State state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getUid

Output only. A globally unique identifier for the node pool.

Generated from protobuf field string uid = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
string

setUid

Output only. A globally unique identifier for the node pool.

Generated from protobuf field string uid = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReconciling

Output only. If set, there are currently changes in flight to the node pool.

Generated from protobuf field bool reconciling = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
bool

setReconciling

Output only. If set, there are currently changes in flight to the node pool.

Generated from protobuf field bool reconciling = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getCreateTime

Output only. The time at which this node pool was created.

Generated from protobuf field .google.protobuf.Timestamp create_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which this node pool was created.

Generated from protobuf field .google.protobuf.Timestamp create_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. The time at which this node pool was last updated.

Generated from protobuf field .google.protobuf.Timestamp update_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time at which this node pool was last updated.

Generated from protobuf field .google.protobuf.Timestamp update_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$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.

Generated from protobuf field string etag = 21;

Returns
TypeDescription
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.

Generated from protobuf field string etag = 21;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field map<string, string> annotations = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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.

Generated from protobuf field map<string, string> annotations = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getMaxPodsConstraint

Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.

Generated from protobuf field .google.cloud.gkemulticloud.v1.MaxPodsConstraint max_pods_constraint = 27 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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.

Generated from protobuf field .google.cloud.gkemulticloud.v1.MaxPodsConstraint max_pods_constraint = 27 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var Google\Cloud\GkeMultiCloud\V1\MaxPodsConstraint
Returns
TypeDescription
$this