Google Cloud Data Catalog V1 Client - Class UpdateTagTemplateRequest (2.0.0)

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

Request message for UpdateTagTemplate.

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

Namespace

Google \ Cloud \ DataCatalog \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ tag_template Google\Cloud\DataCatalog\V1\TagTemplate

Required. The template to update. The name field must be set.
↳ update_mask Google\Protobuf\FieldMask

Names of fields whose values to overwrite on a tag template. Currently, only display_name and is_publicly_readable can be overwritten. 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. Note: Updating the is_publicly_readable field may require up to 12 hours to take effect in search results.

getTagTemplate

Required. The template to update. The name field must be set.

Returns
Type Description
Google\Cloud\DataCatalog\V1\TagTemplate|null

hasTagTemplate

clearTagTemplate

setTagTemplate

Required. The template to update. The name field must be set.

Parameter
Name Description
var Google\Cloud\DataCatalog\V1\TagTemplate
Returns
Type Description
$this

getUpdateMask

Names of fields whose values to overwrite on a tag template. Currently, only display_name and is_publicly_readable can be overwritten.

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. Note: Updating the is_publicly_readable field may require up to 12 hours to take effect in search results.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Names of fields whose values to overwrite on a tag template. Currently, only display_name and is_publicly_readable can be overwritten.

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. Note: Updating the is_publicly_readable field may require up to 12 hours to take effect in search results.

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

static::build

Parameter
Name Description
tagTemplate Google\Cloud\DataCatalog\V1\TagTemplate

Required. The template to update. The name field must be set.
Returns
Type Description
Google\Cloud\DataCatalog\V1\UpdateTagTemplateRequest

static::buildFromTagTemplateUpdateMask

Parameters
Name Description
tagTemplate Google\Cloud\DataCatalog\V1\TagTemplate

Required. The template to update. The name field must be set.
updateMask Google\Protobuf\FieldMask

Names of fields whose values to overwrite on a tag template. Currently, only display_name and is_publicly_readable can be overwritten.

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.

Note: Updating the is_publicly_readable field may require up to 12 hours to take effect in search results.
Returns
Type Description
Google\Cloud\DataCatalog\V1\UpdateTagTemplateRequest