Google Anthos Multi Cloud V1 Client - Class DeleteAwsNodePoolRequest (0.3.0)

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

Request message for AwsClusters.DeleteAwsNodePool method.

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

Methods

build

Parameter
NameDescription
name string

Required. The resource name the AwsNodePool to delete.

AwsNodePool names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>.

See Resource Names for more details on Google Cloud resource names. Please see {@see \Google\Cloud\GkeMultiCloud\V1\AwsClustersClient::awsNodePoolName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\GkeMultiCloud\V1\DeleteAwsNodePoolRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The resource name the AwsNodePool to delete. AwsNodePool names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>. See Resource Names for more details on Google Cloud resource names.

↳ validate_only bool

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

↳ allow_missing bool

If set to true, and the AwsNodePool resource is not found, the request will succeed but no action will be taken on the server and a completed Operation will be returned. Useful for idempotent deletion.

↳ etag string

The current ETag of the AwsNodePool. Allows clients to perform deletions through optimistic concurrency control. If the provided ETag does not match the current etag of the node pool, the request will fail and an ABORTED error will be returned.

getName

Required. The resource name the AwsNodePool to delete.

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

Returns
TypeDescription
string

setName

Required. The resource name the AwsNodePool to delete.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getValidateOnly

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

Returns
TypeDescription
bool

setValidateOnly

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getAllowMissing

If set to true, and the AwsNodePool resource is not found, the request will succeed but no action will be taken on the server and a completed Operation will be returned.

Useful for idempotent deletion.

Returns
TypeDescription
bool

setAllowMissing

If set to true, and the AwsNodePool resource is not found, the request will succeed but no action will be taken on the server and a completed Operation will be returned.

Useful for idempotent deletion.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getEtag

The current ETag of the AwsNodePool.

Allows clients to perform deletions through optimistic concurrency control. If the provided ETag does not match the current etag of the node pool, the request will fail and an ABORTED error will be returned.

Returns
TypeDescription
string

setEtag

The current ETag of the AwsNodePool.

Allows clients to perform deletions through optimistic concurrency control. If the provided ETag does not match the current etag of the node pool, the request will fail and an ABORTED error will be returned.

Parameter
NameDescription
var string
Returns
TypeDescription
$this