Package com.google.cloud.datacatalog.v1beta1

Class TagTemplate

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.datacatalog.v1beta1.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, which can have one or more typed fields.
 The template is used to create and attach the tag 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. See, for example,
 the [TagTemplate
 User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role,
 which includes permission to use the tag template to tag resources.
Protobuf type google.cloud.datacatalog.v1beta1.TagTemplate
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    TagTemplate.Builder
    A tag template defines a tag, which can have one or more typed fields.
    static enum 
    TagTemplate.DataplexTransferStatus
    This enum describes TagTemplate transfer status to Dataplex service.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DATAPLEX_TRANSFER_STATUS_FIELD_NUMBER
     
    static final int
    DISPLAY_NAME_FIELD_NUMBER
     
    static final int
    FIELDS_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsFields(String key)
    Required.
    boolean
    equals(Object obj)
     
    TagTemplate.DataplexTransferStatus
    getDataplexTransferStatus()
    Output only.
    int
    getDataplexTransferStatusValue()
    Output only.
    static TagTemplate
    getDefaultInstance()
     
    TagTemplate
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDisplayName()
    The display name for this template.
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    The display name for this template.
    Map<String,TagTemplateField>
    getFields()
    Deprecated.
    int
    getFieldsCount()
    Required.
    Map<String,TagTemplateField>
    getFieldsMap()
    Required.
    TagTemplateField
    getFieldsOrDefault(String key, TagTemplateField defaultValue)
    Required.
    TagTemplateField
    getFieldsOrThrow(String key)
    Required.
    String
    getName()
    Identifier.
    com.google.protobuf.ByteString
    getNameBytes()
    Identifier.
    com.google.protobuf.Parser<TagTemplate>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static TagTemplate.Builder
    newBuilder()
     
    static TagTemplate.Builder
    newBuilder(TagTemplate prototype)
     
    TagTemplate.Builder
    newBuilderForType()
     
    protected TagTemplate.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static TagTemplate
    parseDelimitedFrom(InputStream input)
     
    static TagTemplate
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TagTemplate
    parseFrom(byte[] data)
     
    static TagTemplate
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TagTemplate
    parseFrom(com.google.protobuf.ByteString data)
     
    static TagTemplate
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TagTemplate
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static TagTemplate
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TagTemplate
    parseFrom(InputStream input)
     
    static TagTemplate
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TagTemplate
    parseFrom(ByteBuffer data)
     
    static TagTemplate
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<TagTemplate>
    parser()
     
    TagTemplate.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • 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:

    • 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. Example:

 * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}

 Note that this TagTemplate and its child resources may not actually be
 stored in the location in this 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. Example:

 * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}

 Note that this TagTemplate and its child resources may not actually be
 stored in the location in this name.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface TagTemplateOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       The display name for this template. Defaults to an empty string.
      string display_name = 2;
      Specified by:
      getDisplayName in interface TagTemplateOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       The display name for this template. Defaults to an empty string.
      string display_name = 2;
      Specified by:
      getDisplayNameBytes in interface TagTemplateOrBuilder
      Returns:
      The bytes for displayName.

    • 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. This map must contain
 at least one field and at most 500 fields.

 The keys to this map are tag template field IDs. Field IDs can contain
 letters (both uppercase and lowercase), numbers (0-9) and underscores (_).
 Field IDs must be at least 1 character long and at most
 64 characters long. Field IDs must start with a letter or underscore.
      map<string, .google.cloud.datacatalog.v1beta1.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. This map must contain
 at least one field and at most 500 fields.

 The keys to this map are tag template field IDs. Field IDs can contain
 letters (both uppercase and lowercase), numbers (0-9) and underscores (_).
 Field IDs must be at least 1 character long and at most
 64 characters long. Field IDs must start with a letter or underscore.
      map<string, .google.cloud.datacatalog.v1beta1.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. This map must contain
 at least one field and at most 500 fields.

 The keys to this map are tag template field IDs. Field IDs can contain
 letters (both uppercase and lowercase), numbers (0-9) and underscores (_).
 Field IDs must be at least 1 character long and at most
 64 characters long. Field IDs must start with a letter or underscore.
      map<string, .google.cloud.datacatalog.v1beta1.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. This map must contain
 at least one field and at most 500 fields.

 The keys to this map are tag template field IDs. Field IDs can contain
 letters (both uppercase and lowercase), numbers (0-9) and underscores (_).
 Field IDs must be at least 1 character long and at most
 64 characters long. Field IDs must start with a letter or underscore.
      map<string, .google.cloud.datacatalog.v1beta1.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. This map must contain
 at least one field and at most 500 fields.

 The keys to this map are tag template field IDs. Field IDs can contain
 letters (both uppercase and lowercase), numbers (0-9) and underscores (_).
 Field IDs must be at least 1 character long and at most
 64 characters long. Field IDs must start with a letter or underscore.
      map<string, .google.cloud.datacatalog.v1beta1.TagTemplateField> fields = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getFieldsOrThrow in interface TagTemplateOrBuilder

    • getDataplexTransferStatusValue

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

    • getDataplexTransferStatus

      public TagTemplate.DataplexTransferStatus getDataplexTransferStatus()
       Output only. Transfer status of the TagTemplate
      .google.cloud.datacatalog.v1beta1.TagTemplate.DataplexTransferStatus dataplex_transfer_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      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