Google Cloud Resource Manager V3 Client - Class DeleteTagKeyRequest (1.0.0)

Reference documentation and code samples for the Google Cloud Resource Manager V3 Client class DeleteTagKeyRequest.

The request message for deleting a TagKey.

Generated from protobuf message google.cloud.resourcemanager.v3.DeleteTagKeyRequest

Namespace

Google \ Cloud \ ResourceManager \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. The resource name of a TagKey to be deleted in the format `tagKeys/123`. The TagKey cannot be a parent of any existing TagValues or it will not be deleted successfully.
`↳ validate_only`	`bool` Optional. Set as true to perform validations necessary for deletion, but not actually perform the action.
`↳ etag`	`string` Optional. The etag known to the client for the expected state of the TagKey. This is to be used for optimistic concurrency.

getName

Required. The resource name of a TagKey to be deleted in the format tagKeys/123. The TagKey cannot be a parent of any existing TagValues or it will not be deleted successfully.

Returns
Type	Description
`string`

setName

Required. The resource name of a TagKey to be deleted in the format tagKeys/123. The TagKey cannot be a parent of any existing TagValues or it will not be deleted successfully.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getValidateOnly

Optional. Set as true to perform validations necessary for deletion, but not actually perform the action.

Returns
Type	Description
`bool`

setValidateOnly

Optional. Set as true to perform validations necessary for deletion, but not actually perform the action.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getEtag

Optional. The etag known to the client for the expected state of the TagKey. This is to be used for optimistic concurrency.

Returns
Type	Description
`string`

setEtag

Optional. The etag known to the client for the expected state of the TagKey. This is to be used for optimistic concurrency.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`name`	`string` Required. The resource name of a TagKey to be deleted in the format `tagKeys/123`. The TagKey cannot be a parent of any existing TagValues or it will not be deleted successfully. Please see Google\Cloud\ResourceManager\V3\TagKeysClient::tagKeyName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\ResourceManager\V3\DeleteTagKeyRequest`