Google Cloud Data Catalog V1 Client - Class UpdateTagTemplateFieldRequest (2.0.2)

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

Request message for UpdateTagTemplateField.

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

Namespace

Google \ Cloud \ DataCatalog \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The name of the tag template field.
↳ tag_template_field Google\Cloud\DataCatalog\V1\TagTemplateField

Required. The template to update.
↳ update_mask Google\Protobuf\FieldMask

Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable: * * display_name * * type.enum_type * * is_required 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 with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed. Additionally, updating a template field from optional to required is not allowed.

getName

Required. The name of the tag template field.

Returns
Type Description
string

setName

Required. The name of the tag template field.

Parameter
Name Description
var string
Returns
Type Description
$this

getTagTemplateField

Required. The template to update.

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

hasTagTemplateField

clearTagTemplateField

setTagTemplateField

Required. The template to update.

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

getUpdateMask

Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:

  • display_name
  • type.enum_type
  • is_required 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 with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed.

Additionally, updating a template field from optional to required is not allowed.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:

  • display_name
  • type.enum_type
  • is_required 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 with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed.

Additionally, updating a template field from optional to required is not allowed.

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

static::build

Parameters
Name Description
name string

Required. The name of the tag template field. Please see Google\Cloud\DataCatalog\V1\DataCatalogClient::tagTemplateFieldName() for help formatting this field.
tagTemplateField Google\Cloud\DataCatalog\V1\TagTemplateField

Required. The template to update.
Returns
Type Description
Google\Cloud\DataCatalog\V1\UpdateTagTemplateFieldRequest

static::buildFromNameTagTemplateFieldUpdateMask

Parameters
Name Description
name string

Required. The name of the tag template field. Please see Google\Cloud\DataCatalog\V1\DataCatalogClient::tagTemplateFieldName() for help formatting this field.
tagTemplateField Google\Cloud\DataCatalog\V1\TagTemplateField

Required. The template to update.
updateMask Google\Protobuf\FieldMask

Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:

    • display_name
    • type.enum_type
    • is_required

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 with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed.

Additionally, updating a template field from optional to required is not allowed.
Returns
Type Description
Google\Cloud\DataCatalog\V1\UpdateTagTemplateFieldRequest