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
Namespace
Google \ Cloud \ GkeMultiCloud \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
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.
↳ 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.
↳ ignore_errors
bool
Optional. If set to true, the deletion of AwsCluster resource will succeed even if errors occur during deleting in cluster resources. Using this parameter may result in orphaned resources in the cluster.
↳ 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
getIgnoreErrors
Optional. If set to true, the deletion of
AwsCluster resource will
succeed even if errors occur during deleting in cluster resources. Using
this parameter may result in orphaned resources in the cluster.
Returns
Type
Description
bool
setIgnoreErrors
Optional. If set to true, the deletion of
AwsCluster resource will
succeed even if errors occur during deleting in cluster resources. Using
this parameter may result in orphaned resources in the cluster.
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.
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
static::build
Parameter
Name
Description
name
string
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. Please see
AwsClustersClient::awsClusterName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Anthos Multi Cloud V1 Client - Class DeleteAwsClusterRequest (1.2.2)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.2 (latest)](/php/docs/reference/cloud-gke-multi-cloud/latest/V1.DeleteAwsClusterRequest)\n- [1.2.1](/php/docs/reference/cloud-gke-multi-cloud/1.2.1/V1.DeleteAwsClusterRequest)\n- [1.1.2](/php/docs/reference/cloud-gke-multi-cloud/1.1.2/V1.DeleteAwsClusterRequest)\n- [1.0.0](/php/docs/reference/cloud-gke-multi-cloud/1.0.0/V1.DeleteAwsClusterRequest)\n- [0.6.1](/php/docs/reference/cloud-gke-multi-cloud/0.6.1/V1.DeleteAwsClusterRequest)\n- [0.5.4](/php/docs/reference/cloud-gke-multi-cloud/0.5.4/V1.DeleteAwsClusterRequest)\n- [0.4.4](/php/docs/reference/cloud-gke-multi-cloud/0.4.4/V1.DeleteAwsClusterRequest)\n- [0.3.0](/php/docs/reference/cloud-gke-multi-cloud/0.3.0/V1.DeleteAwsClusterRequest)\n- [0.2.3](/php/docs/reference/cloud-gke-multi-cloud/0.2.3/V1.DeleteAwsClusterRequest)\n- [0.1.4](/php/docs/reference/cloud-gke-multi-cloud/0.1.4/V1.DeleteAwsClusterRequest) \nReference documentation and code samples for the Google Anthos Multi Cloud V1 Client class DeleteAwsClusterRequest.\n\nRequest message for `AwsClusters.DeleteAwsCluster` method.\n\nGenerated from protobuf message `google.cloud.gkemulticloud.v1.DeleteAwsClusterRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ GkeMultiCloud \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The resource name the\n[AwsCluster](/php/docs/reference/cloud-gke-multi-cloud/latest/V1.AwsCluster) to delete.\n\n`AwsCluster` names are formatted as\n`projects/\u003cproject-id\u003e/locations/\u003cregion\u003e/awsClusters/\u003ccluster-id\u003e`.\nSee [Resource Names](https://cloud.google.com/apis/design/resource_names)\nfor more details on Google Cloud Platform resource names.\n\n### setName\n\nRequired. The resource name the\n[AwsCluster](/php/docs/reference/cloud-gke-multi-cloud/latest/V1.AwsCluster) to delete.\n\n`AwsCluster` names are formatted as\n`projects/\u003cproject-id\u003e/locations/\u003cregion\u003e/awsClusters/\u003ccluster-id\u003e`.\nSee [Resource Names](https://cloud.google.com/apis/design/resource_names)\nfor more details on Google Cloud Platform resource names.\n\n### getValidateOnly\n\nIf set, only validate the request, but do not actually delete the resource.\n\n### setValidateOnly\n\nIf set, only validate the request, but do not actually delete the resource.\n\n### getAllowMissing\n\nIf set to true, and the\n[AwsCluster](/php/docs/reference/cloud-gke-multi-cloud/latest/V1.AwsCluster) resource is not\nfound, the request will succeed but no action will be taken on the server\nand a completed Operation will be returned.\n\nUseful for idempotent deletion.\n\n### setAllowMissing\n\nIf set to true, and the\n[AwsCluster](/php/docs/reference/cloud-gke-multi-cloud/latest/V1.AwsCluster) resource is not\nfound, the request will succeed but no action will be taken on the server\nand a completed Operation will be returned.\n\nUseful for idempotent deletion.\n\n### getIgnoreErrors\n\nOptional. If set to true, the deletion of\n[AwsCluster](/php/docs/reference/cloud-gke-multi-cloud/latest/V1.AwsCluster) resource will\nsucceed even if errors occur during deleting in cluster resources. Using\nthis parameter may result in orphaned resources in the cluster.\n\n### setIgnoreErrors\n\nOptional. If set to true, the deletion of\n[AwsCluster](/php/docs/reference/cloud-gke-multi-cloud/latest/V1.AwsCluster) resource will\nsucceed even if errors occur during deleting in cluster resources. Using\nthis parameter may result in orphaned resources in the cluster.\n\n### getEtag\n\nThe current etag of the\n[AwsCluster](/php/docs/reference/cloud-gke-multi-cloud/latest/V1.AwsCluster).\n\nAllows clients to perform deletions through optimistic concurrency control.\nIf the provided etag does not match the current etag of the cluster,\nthe request will fail and an ABORTED error will be returned.\n\n### setEtag\n\nThe current etag of the\n[AwsCluster](/php/docs/reference/cloud-gke-multi-cloud/latest/V1.AwsCluster).\n\nAllows clients to perform deletions through optimistic concurrency control.\nIf the provided etag does not match the current etag of the cluster,\nthe request will fail and an ABORTED error will be returned.\n\n### static::build"]]
