Google Cloud Data Catalog V1 Client - Class UpdateTagRequest (1.5.1)

Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class UpdateTagRequest.

Request message for UpdateTag.

Generated from protobuf message google.cloud.datacatalog.v1.UpdateTagRequest

Namespace

Google \ Cloud \ DataCatalog \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ tag Google\Cloud\DataCatalog\V1\Tag

Required. The updated tag. The "name" field must be set.

↳ update_mask Google\Protobuf\FieldMask

Names of fields whose values to overwrite on a tag. Currently, a tag has the only modifiable field with the name fields. In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.

getTag

Required. The updated tag. The "name" field must be set.

Returns
TypeDescription
Google\Cloud\DataCatalog\V1\Tag|null

hasTag

clearTag

setTag

Required. The updated tag. The "name" field must be set.

Parameter
NameDescription
var Google\Cloud\DataCatalog\V1\Tag
Returns
TypeDescription
$this

getUpdateMask

Names of fields whose values to overwrite on a tag. Currently, a tag has the only modifiable field with the name fields.

In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Names of fields whose values to overwrite on a tag. Currently, a tag has the only modifiable field with the name fields.

In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
tag Google\Cloud\DataCatalog\V1\Tag

Required. The updated tag. The "name" field must be set.

Returns
TypeDescription
Google\Cloud\DataCatalog\V1\UpdateTagRequest

static::buildFromTagUpdateMask

Parameters
NameDescription
tag Google\Cloud\DataCatalog\V1\Tag

Required. The updated tag. The "name" field must be set.

updateMask Google\Protobuf\FieldMask

Names of fields whose values to overwrite on a tag. Currently, a tag has the only modifiable field with the name fields.

In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.

Returns
TypeDescription
Google\Cloud\DataCatalog\V1\UpdateTagRequest