public final class Taxonomy extends GeneratedMessageV3 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
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ACTIVATED_POLICY_TYPES_FIELD_NUMBER
public static final int ACTIVATED_POLICY_TYPES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
POLICY_TAG_COUNT_FIELD_NUMBER
public static final int POLICY_TAG_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SERVICE_FIELD_NUMBER
public static final int SERVICE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TAXONOMY_TIMESTAMPS_FIELD_NUMBER
public static final int TAXONOMY_TIMESTAMPS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Taxonomy getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Taxonomy.Builder newBuilder()
newBuilder(Taxonomy prototype)
public static Taxonomy.Builder newBuilder(Taxonomy prototype)
| Parameter |
| Name |
Description |
prototype |
Taxonomy
|
public static Taxonomy parseDelimitedFrom(InputStream input)
public static Taxonomy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Taxonomy parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Taxonomy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Taxonomy parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Taxonomy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Taxonomy parseFrom(CodedInputStream input)
public static Taxonomy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Taxonomy parseFrom(InputStream input)
public static Taxonomy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Taxonomy parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Taxonomy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Taxonomy> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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 |
| Name |
Description |
index |
int
The index of the element to return.
|
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 |
| 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.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| 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.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| 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.v1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<Integer> |
A list containing the enum numeric values on the wire for activatedPolicyTypes.
|
getDefaultInstanceForType()
public Taxonomy getDefaultInstanceForType()
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 |
| Type |
Description |
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 |
| Type |
Description |
ByteString |
The bytes for description.
|
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 |
| Type |
Description |
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 |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getName()
Identifier. Resource name of this taxonomy in URL format.
Note: Policy tag manager generates unique taxonomy IDs.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Identifier. Resource name of this taxonomy in URL format.
Note: Policy tag manager generates unique taxonomy IDs.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<Taxonomy> getParserForType()
Overrides
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 |
| Type |
Description |
int |
The policyTagCount.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.v1.Taxonomy.Service service = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.v1.Taxonomy.Service service = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
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];
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.v1.Taxonomy.Service service = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the service field is set.
|
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 |
| Type |
Description |
boolean |
Whether the taxonomyTimestamps field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Taxonomy.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Taxonomy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Taxonomy.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
