Google Cloud Resource Manager V3 Client - Class UpdateTagKeyRequest (1.0.2)

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

The request message for updating a TagKey.

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

Namespace

Google \ Cloud \ ResourceManager \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ tag_key TagKey

Required. The new definition of the TagKey. Only the description and etag fields can be updated by this request. If the etag field is not empty, it must match the etag field of the existing tag key. Otherwise, ABORTED will be returned.
↳ update_mask Google\Protobuf\FieldMask

Fields to be updated. The mask may only contain description or etag. If omitted entirely, both description and etag are assumed to be significant.
↳ validate_only bool

Set as true to perform validations necessary for updating the resource, but not actually perform the action.

getTagKey

Required. The new definition of the TagKey. Only the description and etag fields can be updated by this request. If the etag field is not empty, it must match the etag field of the existing tag key. Otherwise, ABORTED will be returned.

Returns
Type Description
TagKey|null

hasTagKey

clearTagKey

setTagKey

Required. The new definition of the TagKey. Only the description and etag fields can be updated by this request. If the etag field is not empty, it must match the etag field of the existing tag key. Otherwise, ABORTED will be returned.

Parameter
Name Description
var TagKey
Returns
Type Description
$this

getUpdateMask

Fields to be updated. The mask may only contain description or etag. If omitted entirely, both description and etag are assumed to be significant.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Fields to be updated. The mask may only contain description or etag. If omitted entirely, both description and etag are assumed to be significant.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getValidateOnly

Set as true to perform validations necessary for updating the resource, but not actually perform the action.

Returns
Type Description
bool

setValidateOnly

Set as true to perform validations necessary for updating the resource, but not actually perform the action.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
tagKey TagKey

Required. The new definition of the TagKey. Only the description and etag fields can be updated by this request. If the etag field is not empty, it must match the etag field of the existing tag key. Otherwise, ABORTED will be returned.
updateMask Google\Protobuf\FieldMask

Fields to be updated. The mask may only contain description or etag. If omitted entirely, both description and etag are assumed to be significant.
Returns
Type Description
UpdateTagKeyRequest