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 | |
|---|---|
| Name | Description |
name |
string
Required. The resource name the AwsNodePool to delete.
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 | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\DeleteAwsNodePoolRequest | |
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The resource name the AwsNodePool to delete. |
↳ 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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValidateOnly
If set, only validate the request, but do not actually delete the node pool.
| Returns | |
|---|---|
| Type | Description |
bool | |
setValidateOnly
If set, only validate the request, but do not actually delete the node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |