Package com.google.cloud.datacatalog.v1beta1

Class Taxonomy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.datacatalog.v1beta1.Taxonomy
All Implemented Interfaces:
TaxonomyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Taxonomy extends com.google.protobuf.GeneratedMessage implements TaxonomyOrBuilder
 A taxonomy is a collection of policy tags that classify data along a common
 axis. For instance a data *sensitivity* taxonomy could contain policy tags
 denoting PII such as age, zipcode, and SSN. A data *origin* taxonomy could
 contain policy tags to distinguish user data, employee data, partner data,
 public data.
Protobuf type google.cloud.datacatalog.v1beta1.Taxonomy
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:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • POLICY_TAG_COUNT_FIELD_NUMBER

      public static final int POLICY_TAG_COUNT_FIELD_NUMBER
      See Also:

    • TAXONOMY_TIMESTAMPS_FIELD_NUMBER

      public static final int TAXONOMY_TIMESTAMPS_FIELD_NUMBER
      See Also:

    • ACTIVATED_POLICY_TYPES_FIELD_NUMBER

      public static final int ACTIVATED_POLICY_TYPES_FIELD_NUMBER
      See Also:

    • SERVICE_FIELD_NUMBER

      public static final int SERVICE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getName

      public String getName()
       Identifier. Resource name of this taxonomy, whose format is:
 "projects/{project_number}/locations/{location_id}/taxonomies/{id}".
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface TaxonomyOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. Resource name of this taxonomy, whose format is:
 "projects/{project_number}/locations/{location_id}/taxonomies/{id}".
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface TaxonomyOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Required. User defined name of this taxonomy. It must: contain only unicode
 letters, numbers, underscores, dashes and spaces; not start or end with
 spaces; and be at most 200 bytes long when encoded in UTF-8.

 The taxonomy display name must be unique within an organization.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayName in interface TaxonomyOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. User defined name of this taxonomy. It must: contain only unicode
 letters, numbers, underscores, dashes and spaces; not start or end with
 spaces; and be at most 200 bytes long when encoded in UTF-8.

 The taxonomy display name must be unique within an organization.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayNameBytes in interface TaxonomyOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

      public String getDescription()
       Optional. Description of this taxonomy. It must: contain only unicode
 characters, tabs, newlines, carriage returns and page breaks; and be at
 most 2000 bytes long when encoded in UTF-8. If not set, defaults to an
 empty description.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface TaxonomyOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description of this taxonomy. It must: contain only unicode
 characters, tabs, newlines, carriage returns and page breaks; and be at
 most 2000 bytes long when encoded in UTF-8. If not set, defaults to an
 empty description.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface TaxonomyOrBuilder
      Returns:
      The bytes for description.

    • getPolicyTagCount

      public int getPolicyTagCount()
       Output only. Number of policy tags contained in this taxonomy.
      int32 policy_tag_count = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPolicyTagCount in interface TaxonomyOrBuilder
      Returns:
      The policyTagCount.

    • hasTaxonomyTimestamps

      public boolean hasTaxonomyTimestamps()
       Output only. Timestamps about this taxonomy. Only create_time and
 update_time are used.
      .google.cloud.datacatalog.v1beta1.SystemTimestamps taxonomy_timestamps = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasTaxonomyTimestamps in interface TaxonomyOrBuilder
      Returns:
      Whether the taxonomyTimestamps field is set.

    • getTaxonomyTimestamps

      public SystemTimestamps getTaxonomyTimestamps()
       Output only. Timestamps about this taxonomy. Only create_time and
 update_time are used.
      .google.cloud.datacatalog.v1beta1.SystemTimestamps taxonomy_timestamps = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTaxonomyTimestamps in interface TaxonomyOrBuilder
      Returns:
      The taxonomyTimestamps.

    • getTaxonomyTimestampsOrBuilder

      public SystemTimestampsOrBuilder getTaxonomyTimestampsOrBuilder()
       Output only. Timestamps about this taxonomy. Only create_time and
 update_time are used.
      .google.cloud.datacatalog.v1beta1.SystemTimestamps taxonomy_timestamps = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTaxonomyTimestampsOrBuilder in interface TaxonomyOrBuilder

    • getActivatedPolicyTypesList

      public List<Taxonomy.PolicyType> getActivatedPolicyTypesList()
       Optional. A list of policy types that are activated for this taxonomy. If
 not set, defaults to an empty list.
      repeated .google.cloud.datacatalog.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getActivatedPolicyTypesList in interface TaxonomyOrBuilder
      Returns:
      A list containing the activatedPolicyTypes.

    • getActivatedPolicyTypesCount

      public int getActivatedPolicyTypesCount()
       Optional. A list of policy types that are activated for this taxonomy. If
 not set, defaults to an empty list.
      repeated .google.cloud.datacatalog.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getActivatedPolicyTypesCount in interface TaxonomyOrBuilder
      Returns:
      The count of activatedPolicyTypes.

    • getActivatedPolicyTypes

      public Taxonomy.PolicyType getActivatedPolicyTypes(int index)
       Optional. A list of policy types that are activated for this taxonomy. If
 not set, defaults to an empty list.
      repeated .google.cloud.datacatalog.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getActivatedPolicyTypes in interface TaxonomyOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The activatedPolicyTypes at the given index.

    • getActivatedPolicyTypesValueList

      public List<Integer> getActivatedPolicyTypesValueList()
       Optional. A list of policy types that are activated for this taxonomy. If
 not set, defaults to an empty list.
      repeated .google.cloud.datacatalog.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getActivatedPolicyTypesValueList in interface TaxonomyOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for activatedPolicyTypes.

    • getActivatedPolicyTypesValue

      public int getActivatedPolicyTypesValue(int index)
       Optional. A list of policy types that are activated for this taxonomy. If
 not set, defaults to an empty list.
      repeated .google.cloud.datacatalog.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getActivatedPolicyTypesValue in interface TaxonomyOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of activatedPolicyTypes at the given index.

    • hasService

      public boolean hasService()
       Output only. Identity of the service which owns the Taxonomy. This field is
 only populated when the taxonomy is created by a Google Cloud service.
 Currently only 'DATAPLEX' is supported.
      .google.cloud.datacatalog.v1beta1.Taxonomy.Service service = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasService in interface TaxonomyOrBuilder
      Returns:
      Whether the service field is set.

    • getService

      public Taxonomy.Service getService()
       Output only. Identity of the service which owns the Taxonomy. This field is
 only populated when the taxonomy is created by a Google Cloud service.
 Currently only 'DATAPLEX' is supported.
      .google.cloud.datacatalog.v1beta1.Taxonomy.Service service = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getService in interface TaxonomyOrBuilder
      Returns:
      The service.

    • getServiceOrBuilder

      public Taxonomy.ServiceOrBuilder getServiceOrBuilder()
       Output only. Identity of the service which owns the Taxonomy. This field is
 only populated when the taxonomy is created by a Google Cloud service.
 Currently only 'DATAPLEX' is supported.
      .google.cloud.datacatalog.v1beta1.Taxonomy.Service service = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getServiceOrBuilder in interface TaxonomyOrBuilder

    • 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 Taxonomy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Taxonomy.Builder newBuilder()

    • newBuilder

      public static Taxonomy.Builder newBuilder(Taxonomy prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Taxonomy getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Taxonomy> 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 Taxonomy getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder