Package com.google.cloud.datacatalog.v1

Interface TagOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Tag, Tag.Builder
@Generated public interface TagOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Identifier. The resource name of the tag in URL format where tag ID is a
 system-generated identifier.

 Note: The tag itself might not be stored in the location specified in its
 name.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Identifier. The resource name of the tag in URL format where tag ID is a
 system-generated identifier.

 Note: The tag itself might not be stored in the location specified in its
 name.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.

    • getTemplate

      String getTemplate()
       Required. The resource name of the tag template this tag uses. Example:

 `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}`

 This field cannot be modified after creation.
      string template = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The template.

    • getTemplateBytes

      com.google.protobuf.ByteString getTemplateBytes()
       Required. The resource name of the tag template this tag uses. Example:

 `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}`

 This field cannot be modified after creation.
      string template = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for template.

    • getTemplateDisplayName

      String getTemplateDisplayName()
       Output only. The display name of the tag template.
      string template_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The templateDisplayName.

    • getTemplateDisplayNameBytes

      com.google.protobuf.ByteString getTemplateDisplayNameBytes()
       Output only. The display name of the tag template.
      string template_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for templateDisplayName.

    • hasColumn

      boolean hasColumn()
       Resources like entry can have schemas associated with them. This scope
 allows you to attach tags to an individual column based on that schema.

 To attach a tag to a nested column, separate column names with a dot
 (`.`). Example: `column.nested_column`.
      string column = 4;
      Returns:
      Whether the column field is set.

    • getColumn

      String getColumn()
       Resources like entry can have schemas associated with them. This scope
 allows you to attach tags to an individual column based on that schema.

 To attach a tag to a nested column, separate column names with a dot
 (`.`). Example: `column.nested_column`.
      string column = 4;
      Returns:
      The column.

    • getColumnBytes

      com.google.protobuf.ByteString getColumnBytes()
       Resources like entry can have schemas associated with them. This scope
 allows you to attach tags to an individual column based on that schema.

 To attach a tag to a nested column, separate column names with a dot
 (`.`). Example: `column.nested_column`.
      string column = 4;
      Returns:
      The bytes for column.

    • getFieldsCount

      int getFieldsCount()
       Required. Maps the ID of a tag field to its value and additional
 information about that field.

 Tag template defines valid field IDs. A tag
 must have at least 1 field and at most 500 fields.
      map<string, .google.cloud.datacatalog.v1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

    • containsFields

      boolean containsFields(String key)
       Required. Maps the ID of a tag field to its value and additional
 information about that field.

 Tag template defines valid field IDs. A tag
 must have at least 1 field and at most 500 fields.
      map<string, .google.cloud.datacatalog.v1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

    • getFields

      @Deprecated Map<String,TagField> getFields()
      Deprecated.
      Use getFieldsMap() instead.

    • getFieldsMap

      Map<String,TagField> getFieldsMap()
       Required. Maps the ID of a tag field to its value and additional
 information about that field.

 Tag template defines valid field IDs. A tag
 must have at least 1 field and at most 500 fields.
      map<string, .google.cloud.datacatalog.v1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

    • getFieldsOrDefault

      TagField getFieldsOrDefault(String key, TagField defaultValue)
       Required. Maps the ID of a tag field to its value and additional
 information about that field.

 Tag template defines valid field IDs. A tag
 must have at least 1 field and at most 500 fields.
      map<string, .google.cloud.datacatalog.v1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

    • getFieldsOrThrow

      TagField getFieldsOrThrow(String key)
       Required. Maps the ID of a tag field to its value and additional
 information about that field.

 Tag template defines valid field IDs. A tag
 must have at least 1 field and at most 500 fields.
      map<string, .google.cloud.datacatalog.v1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

    • getDataplexTransferStatusValue

      int getDataplexTransferStatusValue()
       Output only. Denotes the transfer status of the Tag Template.
      .google.cloud.datacatalog.v1.TagTemplate.DataplexTransferStatus dataplex_transfer_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for dataplexTransferStatus.

    • getDataplexTransferStatus

      TagTemplate.DataplexTransferStatus getDataplexTransferStatus()
       Output only. Denotes the transfer status of the Tag Template.
      .google.cloud.datacatalog.v1.TagTemplate.DataplexTransferStatus dataplex_transfer_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The dataplexTransferStatus.

    • getScopeCase

      Tag.ScopeCase getScopeCase()