public final class Taxonomy extends GeneratedMessageV3 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
Fields
ACTIVATED_POLICY_TYPES_FIELD_NUMBER
public static final int ACTIVATED_POLICY_TYPES_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| index | int
The index of the element to return.
|
Returns
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];
| Type | Description |
| 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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| 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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| 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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| List<Integer> | A list containing the enum numeric values on the wire for activatedPolicyTypes.
|
getDefaultInstance()
public static Taxonomy getDefaultInstance()
Returns
getDefaultInstanceForType()
public Taxonomy getDefaultInstanceForType()
Returns
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];
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public 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];
| Type | Description |
| ByteString | The bytes for description.
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The displayName.
|
getDisplayNameBytes()
public 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.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for displayName.
|
getName()
Output only. Resource name of this taxonomy, whose format is:
"projects/{project_number}/locations/{location_id}/taxonomies/{id}".
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. Resource name of this taxonomy, whose format is:
"projects/{project_number}/locations/{location_id}/taxonomies/{id}".
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
getParserForType()
public Parser<Taxonomy> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static Taxonomy.Builder newBuilder()
Returns
newBuilder(Taxonomy prototype)
public static Taxonomy.Builder newBuilder(Taxonomy prototype)
Parameter
Returns
newBuilderForType()
public Taxonomy.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Taxonomy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static Taxonomy parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Taxonomy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Taxonomy parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Taxonomy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Taxonomy parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Taxonomy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Taxonomy parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Taxonomy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Taxonomy parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Taxonomy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Taxonomy parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Taxonomy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Taxonomy> parser()
Returns
toBuilder()
public Taxonomy.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
