Google Anthos Multi Cloud V1 Client - Class DeleteAttachedClusterRequest (0.4.4)

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

Request message for AttachedClusters.DeleteAttachedCluster method.

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

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 AttachedCluster to delete. `AttachedCluster` names are formatted as `projects/<project-id>/locations/<region>/attachedClusters/<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 AttachedCluster 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` If set to true, the deletion of AttachedCluster 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 AttachedCluster. 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 AttachedCluster to delete.

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

Returns
Type	Description
`string`

setName

Required. The resource name the AttachedCluster to delete.

AttachedCluster names are formatted as projects/<project-id>/locations/<region>/attachedClusters/<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 AttachedCluster 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 AttachedCluster 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

If set to true, the deletion of AttachedCluster 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

If set to true, the deletion of AttachedCluster resource will succeed even if errors occur during deleting in cluster resources.

Using this parameter may result in orphaned resources in the cluster.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getEtag

The current etag of the AttachedCluster.

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 AttachedCluster.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter

Name Description

name

string

Required. The resource name the AttachedCluster to delete.

AttachedCluster names are formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names. Please see Google\Cloud\GkeMultiCloud\V1\AttachedClustersClient::attachedClusterName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\GkeMultiCloud\V1\DeleteAttachedClusterRequest`