Package com.google.cloud.datacatalog.v1

Class TagTemplate

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.datacatalog.v1.TagTemplate
All Implemented Interfaces:
TagTemplateOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class TagTemplate extends com.google.protobuf.GeneratedMessage implements TagTemplateOrBuilder
 A tag template defines a tag that can have one or more typed fields.

 The template is used to create tags that are attached to Google Cloud
 resources. [Tag template roles]
 (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles)
 provide permissions to create, edit, and use the template. For example,
 see the [TagTemplate User]
 (https://cloud.google.com/data-catalog/docs/how-to/template-user) role
 that includes a permission to use the tag template to tag resources.
Protobuf type google.cloud.datacatalog.v1.TagTemplate
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • IS_PUBLICLY_READABLE_FIELD_NUMBER

      public static final int IS_PUBLICLY_READABLE_FIELD_NUMBER
      See Also:

    • FIELDS_FIELD_NUMBER

      public static final int FIELDS_FIELD_NUMBER
      See Also:

    • DATAPLEX_TRANSFER_STATUS_FIELD_NUMBER

      public static final int DATAPLEX_TRANSFER_STATUS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       Identifier. The resource name of the tag template in URL format.

 Note: The tag template itself and its child resources might not be
 stored in the location specified in its name.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface TagTemplateOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. The resource name of the tag template in URL format.

 Note: The tag template itself and its child resources might not be
 stored in the location specified in its name.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface TagTemplateOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Display name for this template. Defaults to an empty string.

 The name must contain only Unicode letters, numbers (0-9), underscores (_),
 dashes (-), spaces ( ), and can't start or end with spaces.
 The maximum length is 200 characters.
      string display_name = 2;
      Specified by:
      getDisplayName in interface TagTemplateOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Display name for this template. Defaults to an empty string.

 The name must contain only Unicode letters, numbers (0-9), underscores (_),
 dashes (-), spaces ( ), and can't start or end with spaces.
 The maximum length is 200 characters.
      string display_name = 2;
      Specified by:
      getDisplayNameBytes in interface TagTemplateOrBuilder
      Returns:
      The bytes for displayName.

    • getIsPubliclyReadable

      public boolean getIsPubliclyReadable()
       Indicates whether tags created with this template are public. Public tags
 do not require tag template access to appear in
 [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags] API response.

 Additionally, you can search for a public tag by value with a
 simple search query in addition to using a ``tag:`` predicate.
      bool is_publicly_readable = 5;
      Specified by:
      getIsPubliclyReadable in interface TagTemplateOrBuilder
      Returns:
      The isPubliclyReadable.

    • getFieldsCount

      public int getFieldsCount()
      Description copied from interface: TagTemplateOrBuilder
       Required. Map of tag template field IDs to the settings for the field.
 This map is an exhaustive list of the allowed fields. The map must contain
 at least one field and at most 500 fields.

 The keys to this map are tag template field IDs. The IDs have the
 following limitations:

 * Can contain uppercase and lowercase letters, numbers (0-9) and
 underscores (_).
 * Must be at least 1 character and at most 64 characters long.
 * Must start with a letter or underscore.
      map<string, .google.cloud.datacatalog.v1.TagTemplateField> fields = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getFieldsCount in interface TagTemplateOrBuilder

    • containsFields

      public boolean containsFields(String key)
       Required. Map of tag template field IDs to the settings for the field.
 This map is an exhaustive list of the allowed fields. The map must contain
 at least one field and at most 500 fields.

 The keys to this map are tag template field IDs. The IDs have the
 following limitations:

 * Can contain uppercase and lowercase letters, numbers (0-9) and
 underscores (_).
 * Must be at least 1 character and at most 64 characters long.
 * Must start with a letter or underscore.
      map<string, .google.cloud.datacatalog.v1.TagTemplateField> fields = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      containsFields in interface TagTemplateOrBuilder

    • getFields

      @Deprecated public Map<String,TagTemplateField> getFields()
      Deprecated.
      Use getFieldsMap() instead.
      Specified by:
      getFields in interface TagTemplateOrBuilder

    • getFieldsMap

      public Map<String,TagTemplateField> getFieldsMap()
       Required. Map of tag template field IDs to the settings for the field.
 This map is an exhaustive list of the allowed fields. The map must contain
 at least one field and at most 500 fields.

 The keys to this map are tag template field IDs. The IDs have the
 following limitations:

 * Can contain uppercase and lowercase letters, numbers (0-9) and
 underscores (_).
 * Must be at least 1 character and at most 64 characters long.
 * Must start with a letter or underscore.
      map<string, .google.cloud.datacatalog.v1.TagTemplateField> fields = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getFieldsMap in interface TagTemplateOrBuilder

    • getFieldsOrDefault

      public TagTemplateField getFieldsOrDefault(String key, TagTemplateField defaultValue)
       Required. Map of tag template field IDs to the settings for the field.
 This map is an exhaustive list of the allowed fields. The map must contain
 at least one field and at most 500 fields.

 The keys to this map are tag template field IDs. The IDs have the
 following limitations:

 * Can contain uppercase and lowercase letters, numbers (0-9) and
 underscores (_).
 * Must be at least 1 character and at most 64 characters long.
 * Must start with a letter or underscore.
      map<string, .google.cloud.datacatalog.v1.TagTemplateField> fields = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getFieldsOrDefault in interface TagTemplateOrBuilder

    • getFieldsOrThrow

      public TagTemplateField getFieldsOrThrow(String key)
       Required. Map of tag template field IDs to the settings for the field.
 This map is an exhaustive list of the allowed fields. The map must contain
 at least one field and at most 500 fields.

 The keys to this map are tag template field IDs. The IDs have the
 following limitations:

 * Can contain uppercase and lowercase letters, numbers (0-9) and
 underscores (_).
 * Must be at least 1 character and at most 64 characters long.
 * Must start with a letter or underscore.
      map<string, .google.cloud.datacatalog.v1.TagTemplateField> fields = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getFieldsOrThrow in interface TagTemplateOrBuilder

    • getDataplexTransferStatusValue

      public int getDataplexTransferStatusValue()
       Optional. Transfer status of the TagTemplate
      .google.cloud.datacatalog.v1.TagTemplate.DataplexTransferStatus dataplex_transfer_status = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDataplexTransferStatusValue in interface TagTemplateOrBuilder
      Returns:
      The enum numeric value on the wire for dataplexTransferStatus.

    • getDataplexTransferStatus

      public TagTemplate.DataplexTransferStatus getDataplexTransferStatus()
       Optional. Transfer status of the TagTemplate
      .google.cloud.datacatalog.v1.TagTemplate.DataplexTransferStatus dataplex_transfer_status = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDataplexTransferStatus in interface TagTemplateOrBuilder
      Returns:
      The dataplexTransferStatus.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static TagTemplate parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TagTemplate parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TagTemplate parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TagTemplate parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TagTemplate parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TagTemplate parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TagTemplate parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TagTemplate parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TagTemplate parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TagTemplate parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TagTemplate parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TagTemplate parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public TagTemplate.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static TagTemplate.Builder newBuilder()

    • newBuilder

      public static TagTemplate.Builder newBuilder(TagTemplate prototype)

    • toBuilder

      public TagTemplate.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected TagTemplate.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static TagTemplate getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TagTemplate> parser()

    • getParserForType

      public com.google.protobuf.Parser<TagTemplate> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public TagTemplate getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder