Class Taxonomy.Builder (1.14.0)

public static final class Taxonomy.Builder extends GeneratedMessageV3.Builder<Taxonomy.Builder> implements TaxonomyOrBuilder

A taxonomy is a collection of hierarchical policy tags that classify data along a common axis. For example, a "data sensitivity" taxonomy might contain the following policy tags: `

  • PII
    • Account number
    • Age
    • SSN
    • Zipcode
  • Financials
    • Revenue
A "data origin" taxonomy might contain the following policy tags:
  • User data
  • Employee data
  • Partner data
  • Public data
  • `

    Protobuf type google.cloud.datacatalog.v1.Taxonomy

    Implements

    TaxonomyOrBuilder

    Static Methods

    getDescriptor()

    public static final Descriptors.Descriptor getDescriptor()
    Returns
    TypeDescription
    Descriptor

    Methods

    addActivatedPolicyTypes(Taxonomy.PolicyType value)

    public Taxonomy.Builder addActivatedPolicyTypes(Taxonomy.PolicyType value)

    Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.

    repeated .google.cloud.datacatalog.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

    Parameter
    NameDescription
    valueTaxonomy.PolicyType

    The activatedPolicyTypes to add.

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    addActivatedPolicyTypesValue(int value)

    public Taxonomy.Builder addActivatedPolicyTypesValue(int value)

    Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.

    repeated .google.cloud.datacatalog.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

    Parameter
    NameDescription
    valueint

    The enum numeric value on the wire for activatedPolicyTypes to add.

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    addAllActivatedPolicyTypes(Iterable<? extends Taxonomy.PolicyType> values)

    public Taxonomy.Builder addAllActivatedPolicyTypes(Iterable<? extends Taxonomy.PolicyType> values)

    Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.

    repeated .google.cloud.datacatalog.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

    Parameter
    NameDescription
    valuesIterable<? extends com.google.cloud.datacatalog.v1.Taxonomy.PolicyType>

    The activatedPolicyTypes to add.

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    addAllActivatedPolicyTypesValue(Iterable<Integer> values)

    public Taxonomy.Builder addAllActivatedPolicyTypesValue(Iterable<Integer> values)

    Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.

    repeated .google.cloud.datacatalog.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

    Parameter
    NameDescription
    valuesIterable<Integer>

    The enum numeric values on the wire for activatedPolicyTypes to add.

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    addRepeatedField(Descriptors.FieldDescriptor field, Object value)

    public Taxonomy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
    Parameters
    NameDescription
    fieldFieldDescriptor
    valueObject
    Returns
    TypeDescription
    Taxonomy.Builder
    Overrides

    build()

    public Taxonomy build()
    Returns
    TypeDescription
    Taxonomy

    buildPartial()

    public Taxonomy buildPartial()
    Returns
    TypeDescription
    Taxonomy

    clear()

    public Taxonomy.Builder clear()
    Returns
    TypeDescription
    Taxonomy.Builder
    Overrides

    clearActivatedPolicyTypes()

    public Taxonomy.Builder clearActivatedPolicyTypes()

    Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.

    repeated .google.cloud.datacatalog.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    clearDescription()

    public Taxonomy.Builder clearDescription()

    Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.

    string description = 3 [(.google.api.field_behavior) = OPTIONAL];

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    clearDisplayName()

    public Taxonomy.Builder clearDisplayName()

    Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and 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];

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    clearField(Descriptors.FieldDescriptor field)

    public Taxonomy.Builder clearField(Descriptors.FieldDescriptor field)
    Parameter
    NameDescription
    fieldFieldDescriptor
    Returns
    TypeDescription
    Taxonomy.Builder
    Overrides

    clearName()

    public Taxonomy.Builder clearName()

    Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.

    string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    clearOneof(Descriptors.OneofDescriptor oneof)

    public Taxonomy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
    Parameter
    NameDescription
    oneofOneofDescriptor
    Returns
    TypeDescription
    Taxonomy.Builder
    Overrides

    clearPolicyTagCount()

    public Taxonomy.Builder clearPolicyTagCount()

    Output only. Number of policy tags in this taxonomy.

    int32 policy_tag_count = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    clearTaxonomyTimestamps()

    public Taxonomy.Builder clearTaxonomyTimestamps()

    Output only. Creation and modification timestamps of this taxonomy.

    .google.cloud.datacatalog.v1.SystemTimestamps taxonomy_timestamps = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    TypeDescription
    Taxonomy.Builder

    clone()

    public Taxonomy.Builder clone()
    Returns
    TypeDescription
    Taxonomy.Builder
    Overrides

    getActivatedPolicyTypes(int index)

    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.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

    Parameter
    NameDescription
    indexint

    The index of the element to return.

    Returns
    TypeDescription
    Taxonomy.PolicyType

    The activatedPolicyTypes at the given index.

    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.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

    Returns
    TypeDescription
    int

    The count of activatedPolicyTypes.

    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.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

    Returns
    TypeDescription
    List<PolicyType>

    A list containing the activatedPolicyTypes.

    getActivatedPolicyTypesValue(int index)

    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.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

    Parameter
    NameDescription
    indexint

    The index of the value to return.

    Returns
    TypeDescription
    int

    The enum numeric value on the wire of 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.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

    Returns
    TypeDescription
    List<Integer>

    A list containing the enum numeric values on the wire for activatedPolicyTypes.

    getDefaultInstanceForType()

    public Taxonomy getDefaultInstanceForType()
    Returns
    TypeDescription
    Taxonomy

    getDescription()

    public String getDescription()

    Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.

    string description = 3 [(.google.api.field_behavior) = OPTIONAL];

    Returns
    TypeDescription
    String

    The description.

    getDescriptionBytes()

    public ByteString getDescriptionBytes()

    Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.

    string description = 3 [(.google.api.field_behavior) = OPTIONAL];

    Returns
    TypeDescription
    ByteString

    The bytes for description.

    getDescriptorForType()

    public Descriptors.Descriptor getDescriptorForType()
    Returns
    TypeDescription
    Descriptor
    Overrides

    getDisplayName()

    public String getDisplayName()

    Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and 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];

    Returns
    TypeDescription
    String

    The displayName.

    getDisplayNameBytes()

    public ByteString getDisplayNameBytes()

    Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and 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];

    Returns
    TypeDescription
    ByteString

    The bytes for displayName.

    getName()

    public String getName()

    Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.

    string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    TypeDescription
    String

    The name.

    getNameBytes()

    public ByteString getNameBytes()

    Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.

    string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    TypeDescription
    ByteString

    The bytes for name.

    getPolicyTagCount()

    public int getPolicyTagCount()

    Output only. Number of policy tags in this taxonomy.

    int32 policy_tag_count = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    TypeDescription
    int

    The policyTagCount.

    getTaxonomyTimestamps()

    public SystemTimestamps getTaxonomyTimestamps()

    Output only. Creation and modification timestamps of this taxonomy.

    .google.cloud.datacatalog.v1.SystemTimestamps taxonomy_timestamps = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    TypeDescription
    SystemTimestamps

    The taxonomyTimestamps.

    getTaxonomyTimestampsBuilder()

    public SystemTimestamps.Builder getTaxonomyTimestampsBuilder()

    Output only. Creation and modification timestamps of this taxonomy.

    .google.cloud.datacatalog.v1.SystemTimestamps taxonomy_timestamps = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    TypeDescription
    SystemTimestamps.Builder

    getTaxonomyTimestampsOrBuilder()

    public SystemTimestampsOrBuilder getTaxonomyTimestampsOrBuilder()

    Output only. Creation and modification timestamps of this taxonomy.

    .google.cloud.datacatalog.v1.SystemTimestamps taxonomy_timestamps = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    TypeDescription
    SystemTimestampsOrBuilder

    hasTaxonomyTimestamps()

    public boolean hasTaxonomyTimestamps()

    Output only. Creation and modification timestamps of this taxonomy.

    .google.cloud.datacatalog.v1.SystemTimestamps taxonomy_timestamps = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    TypeDescription
    boolean

    Whether the taxonomyTimestamps field is set.

    internalGetFieldAccessorTable()

    protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
    Returns
    TypeDescription
    FieldAccessorTable
    Overrides

    isInitialized()

    public final boolean isInitialized()
    Returns
    TypeDescription
    boolean
    Overrides

    mergeFrom(Taxonomy other)

    public Taxonomy.Builder mergeFrom(Taxonomy other)
    Parameter
    NameDescription
    otherTaxonomy
    Returns
    TypeDescription
    Taxonomy.Builder

    mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

    public Taxonomy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
    Parameters
    NameDescription
    inputCodedInputStream
    extensionRegistryExtensionRegistryLite
    Returns
    TypeDescription
    Taxonomy.Builder
    Overrides Exceptions
    TypeDescription
    IOException

    mergeFrom(Message other)

    public Taxonomy.Builder mergeFrom(Message other)
    Parameter
    NameDescription
    otherMessage
    Returns
    TypeDescription
    Taxonomy.Builder
    Overrides

    mergeTaxonomyTimestamps(SystemTimestamps value)

    public Taxonomy.Builder mergeTaxonomyTimestamps(SystemTimestamps value)

    Output only. Creation and modification timestamps of this taxonomy.

    .google.cloud.datacatalog.v1.SystemTimestamps taxonomy_timestamps = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    NameDescription
    valueSystemTimestamps
    Returns
    TypeDescription
    Taxonomy.Builder

    mergeUnknownFields(UnknownFieldSet unknownFields)

    public final Taxonomy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
    Parameter
    NameDescription
    unknownFieldsUnknownFieldSet
    Returns
    TypeDescription
    Taxonomy.Builder
    Overrides

    setActivatedPolicyTypes(int index, Taxonomy.PolicyType value)

    public Taxonomy.Builder setActivatedPolicyTypes(int index, Taxonomy.PolicyType value)

    Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.

    repeated .google.cloud.datacatalog.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

    Parameters
    NameDescription
    indexint

    The index to set the value at.

    valueTaxonomy.PolicyType

    The activatedPolicyTypes to set.

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    setActivatedPolicyTypesValue(int index, int value)

    public Taxonomy.Builder setActivatedPolicyTypesValue(int index, int value)

    Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.

    repeated .google.cloud.datacatalog.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];

    Parameters
    NameDescription
    indexint

    The index to set the value at.

    valueint

    The enum numeric value on the wire for activatedPolicyTypes to set.

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    setDescription(String value)

    public Taxonomy.Builder setDescription(String value)

    Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.

    string description = 3 [(.google.api.field_behavior) = OPTIONAL];

    Parameter
    NameDescription
    valueString

    The description to set.

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    setDescriptionBytes(ByteString value)

    public Taxonomy.Builder setDescriptionBytes(ByteString value)

    Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.

    string description = 3 [(.google.api.field_behavior) = OPTIONAL];

    Parameter
    NameDescription
    valueByteString

    The bytes for description to set.

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    setDisplayName(String value)

    public Taxonomy.Builder setDisplayName(String value)

    Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and 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];

    Parameter
    NameDescription
    valueString

    The displayName to set.

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    setDisplayNameBytes(ByteString value)

    public Taxonomy.Builder setDisplayNameBytes(ByteString value)

    Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and 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];

    Parameter
    NameDescription
    valueByteString

    The bytes for displayName to set.

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    setField(Descriptors.FieldDescriptor field, Object value)

    public Taxonomy.Builder setField(Descriptors.FieldDescriptor field, Object value)
    Parameters
    NameDescription
    fieldFieldDescriptor
    valueObject
    Returns
    TypeDescription
    Taxonomy.Builder
    Overrides

    setName(String value)

    public Taxonomy.Builder setName(String value)

    Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.

    string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    NameDescription
    valueString

    The name to set.

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    setNameBytes(ByteString value)

    public Taxonomy.Builder setNameBytes(ByteString value)

    Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.

    string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    NameDescription
    valueByteString

    The bytes for name to set.

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    setPolicyTagCount(int value)

    public Taxonomy.Builder setPolicyTagCount(int value)

    Output only. Number of policy tags in this taxonomy.

    int32 policy_tag_count = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    NameDescription
    valueint

    The policyTagCount to set.

    Returns
    TypeDescription
    Taxonomy.Builder

    This builder for chaining.

    setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

    public Taxonomy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
    Parameters
    NameDescription
    fieldFieldDescriptor
    indexint
    valueObject
    Returns
    TypeDescription
    Taxonomy.Builder
    Overrides

    setTaxonomyTimestamps(SystemTimestamps value)

    public Taxonomy.Builder setTaxonomyTimestamps(SystemTimestamps value)

    Output only. Creation and modification timestamps of this taxonomy.

    .google.cloud.datacatalog.v1.SystemTimestamps taxonomy_timestamps = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    NameDescription
    valueSystemTimestamps
    Returns
    TypeDescription
    Taxonomy.Builder

    setTaxonomyTimestamps(SystemTimestamps.Builder builderForValue)

    public Taxonomy.Builder setTaxonomyTimestamps(SystemTimestamps.Builder builderForValue)

    Output only. Creation and modification timestamps of this taxonomy.

    .google.cloud.datacatalog.v1.SystemTimestamps taxonomy_timestamps = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    NameDescription
    builderForValueSystemTimestamps.Builder
    Returns
    TypeDescription
    Taxonomy.Builder

    setUnknownFields(UnknownFieldSet unknownFields)

    public final Taxonomy.Builder setUnknownFields(UnknownFieldSet unknownFields)
    Parameter
    NameDescription
    unknownFieldsUnknownFieldSet
    Returns
    TypeDescription
    Taxonomy.Builder
    Overrides