Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class DeleteAwsClusterRequest.
Request message for AwsClusters.DeleteAwsCluster method.
Generated from protobuf message google.cloud.gkemulticloud.v1.DeleteAwsClusterRequest
Methods
build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. The resource name the AwsCluster to delete.
See Resource Names for more details on Google Cloud Platform resource names. Please see {@see \Google\Cloud\GkeMultiCloud\V1\AwsClustersClient::awsClusterName()} for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\DeleteAwsClusterRequest | |
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The resource name the AwsCluster to delete. |
↳ validate_only |
bool
If set, only validate the request, but do not actually delete the resource. |
↳ allow_missing |
bool
If set to true, and the AwsCluster 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 AwsCluster. Allows clients to perform deletions through optimistic concurrency control. If the provided etag does not match the current etag of the cluster, the request will fail and an ABORTED error will be returned. |
getName
Required. The resource name the AwsCluster to delete.
AwsCluster names are formatted as
projects/<project-id>/locations/<region>/awsClusters/<cluster-id>.
See Resource Names
for more details on Google Cloud Platform resource names.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. The resource name the AwsCluster to delete.
AwsCluster names are formatted as
projects/<project-id>/locations/<region>/awsClusters/<cluster-id>.
See Resource Names
for more details on Google Cloud Platform resource names.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValidateOnly
If set, only validate the request, but do not actually delete the resource.
| Returns | |
|---|---|
| Type | Description |
bool | |
setValidateOnly
If set, only validate the request, but do not actually delete the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAllowMissing
If set to true, and the AwsCluster 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 AwsCluster 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 AwsCluster.
Allows clients to perform deletions through optimistic concurrency control. If the provided etag does not match the current etag of the cluster, the request will fail and an ABORTED error will be returned.
| Returns | |
|---|---|
| Type | Description |
string | |
setEtag
The current etag of the AwsCluster.
Allows clients to perform deletions through optimistic concurrency control. If the provided etag does not match the current etag of the cluster, the request will fail and an ABORTED error will be returned.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |