Google Anthos Multi Cloud V1 Client - Class CreateAwsNodePoolRequest (0.5.4)

Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class CreateAwsNodePoolRequest.

Response message for AwsClusters.CreateAwsNodePool method.

Generated from protobuf message google.cloud.gkemulticloud.v1.CreateAwsNodePoolRequest

Namespace

Google \ Cloud \ GkeMultiCloud \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The AwsCluster resource where this node pool will be created. AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>. See Resource Names for more details on Google Cloud resource names.
↳ aws_node_pool Google\Cloud\GkeMultiCloud\V1\AwsNodePool

Required. The specification of the AwsNodePool to create.
↳ aws_node_pool_id string

Required. A client provided ID the resource. Must be unique within the parent resource. The provided ID will be part of the AwsNodePool resource name formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>. Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.
↳ validate_only bool

If set, only validate the request, but do not actually create the node pool.

getParent

Required. The AwsCluster resource where this node pool will be created.

AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>. See Resource Names for more details on Google Cloud resource names.

Returns
Type Description
string

setParent

Required. The AwsCluster resource where this node pool will be created.

AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>. See Resource Names for more details on Google Cloud resource names.

Parameter
Name Description
var string
Returns
Type Description
$this

getAwsNodePool

Required. The specification of the AwsNodePool to create.

Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\AwsNodePool|null

hasAwsNodePool

clearAwsNodePool

setAwsNodePool

Required. The specification of the AwsNodePool to create.

Parameter
Name Description
var Google\Cloud\GkeMultiCloud\V1\AwsNodePool
Returns
Type Description
$this

getAwsNodePoolId

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the AwsNodePool resource name formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>. Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

Returns
Type Description
string

setAwsNodePoolId

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the AwsNodePool resource name formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>. Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getValidateOnly

If set, only validate the request, but do not actually create the node pool.

Returns
Type Description
bool

setValidateOnly

If set, only validate the request, but do not actually create the node pool.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The AwsCluster resource where this node pool will be created.

AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>.

See Resource Names for more details on Google Cloud resource names. Please see Google\Cloud\GkeMultiCloud\V1\AwsClustersClient::awsClusterName() for help formatting this field.
awsNodePool Google\Cloud\GkeMultiCloud\V1\AwsNodePool

Required. The specification of the AwsNodePool to create.
awsNodePoolId string

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the AwsNodePool resource name formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.
Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\CreateAwsNodePoolRequest