Interface UpdateTagTemplateFieldRequestOrBuilder (1.26.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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TagTemplateFieldOrBuilder

getUpdateMask()

public abstract FieldMask getUpdateMask()

Optional. The field mask specifies the parts of the template to be updated. Allowed fields:

  • display_name
  • type.enum_type
  • is_required

    If update_mask is not set or empty, all of the allowed fields above will be updated.

    When updating an enum type, the provided values will be merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted nor renamed. Updating a template field from optional to required is NOT allowed.

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

Returns
TypeDescription
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

public abstract FieldMaskOrBuilder getUpdateMaskOrBuilder()

Optional. The field mask specifies the parts of the template to be updated. Allowed fields:

  • display_name
  • type.enum_type
  • is_required

    If update_mask is not set or empty, all of the allowed fields above will be updated.

    When updating an enum type, the provided values will be merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted nor renamed. Updating a template field from optional to required is NOT allowed.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the tagTemplateField field is set.

hasUpdateMask()

public abstract boolean hasUpdateMask()

Optional. The field mask specifies the parts of the template to be updated. Allowed fields:

  • display_name
  • type.enum_type
  • is_required

    If update_mask is not set or empty, all of the allowed fields above will be updated.

    When updating an enum type, the provided values will be merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted nor renamed. Updating a template field from optional to required is NOT allowed.

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

Returns
TypeDescription
boolean

Whether the updateMask field is set.