Google Cloud Resource Manager V3 Client - Class DeleteTagKeyRequest (0.5.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

Methods

build

Parameter
NameDescription
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 {@see \Google\Cloud\ResourceManager\V3\TagKeysClient::tagKeyName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\ResourceManager\V3\DeleteTagKeyRequest

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getValidateOnly

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

Returns
TypeDescription
bool

setValidateOnly

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this