Interface UpdateTagTemplateFieldRequestOrBuilder (1.52.0)

public interface UpdateTagTemplateFieldRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getName()

public abstract String getName()

Required. The name of the tag template field. Example:

  • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The name of the tag template field. Example:

  • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getTagTemplateField()

public abstract TagTemplateField getTagTemplateField()

Required. The template to update.

.google.cloud.datacatalog.v1beta1.TagTemplateField tag_template_field = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TagTemplateField

The tagTemplateField.

getTagTemplateFieldOrBuilder()

public abstract TagTemplateFieldOrBuilder getTagTemplateFieldOrBuilder()

Required. The template to update.

.google.cloud.datacatalog.v1beta1.TagTemplateField tag_template_field = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TagTemplateFieldOrBuilder

getUpdateMask()

public abstract FieldMask 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.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

public abstract FieldMaskOrBuilder getUpdateMaskOrBuilder()

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.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMaskOrBuilder

hasTagTemplateField()

public abstract boolean hasTagTemplateField()

Required. The template to update.

.google.cloud.datacatalog.v1beta1.TagTemplateField tag_template_field = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the tagTemplateField field is set.

hasUpdateMask()

public abstract boolean hasUpdateMask()

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.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the updateMask field is set.