public static final class Taxonomy.Builder extends GeneratedMessageV3.Builder<Taxonomy.Builder> 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
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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | int
The enum numeric value on the wire for activatedPolicyTypes to add.
|
Returns
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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| values | Iterable<? extends com.google.cloud.datacatalog.v1beta1.Taxonomy.PolicyType>
The activatedPolicyTypes to add.
|
Returns
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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| values | Iterable<Integer>
The enum numeric values on the wire for activatedPolicyTypes to add.
|
Returns
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Taxonomy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
Returns
buildPartial()
public Taxonomy buildPartial()
Returns
clear()
public Taxonomy.Builder clear()
Returns
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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
clearDescription()
public Taxonomy.Builder clearDescription()
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];
clearDisplayName()
public Taxonomy.Builder clearDisplayName()
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];
clearField(Descriptors.FieldDescriptor field)
public Taxonomy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearName()
public Taxonomy.Builder clearName()
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];
clearOneof(Descriptors.OneofDescriptor oneof)
public Taxonomy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clone()
public Taxonomy.Builder clone()
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.
|
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
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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];
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(Taxonomy other)
public Taxonomy.Builder mergeFrom(Taxonomy other)
Parameter
Returns
public Taxonomy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Taxonomy.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Taxonomy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| index | int
The index to set the value at.
|
| value | Taxonomy.PolicyType
The activatedPolicyTypes to set.
|
Returns
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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| index | int
The index of the value to return.
|
| value | int
|
Returns
| Type | Description |
| Taxonomy.Builder | The enum numeric value on the wire of activatedPolicyTypes at the given index.
|
setDescription(String value)
public Taxonomy.Builder setDescription(String value)
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];
| Name | Description |
| value | String
The description to set.
|
Returns
setDescriptionBytes(ByteString value)
public Taxonomy.Builder setDescriptionBytes(ByteString value)
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];
| Name | Description |
| value | ByteString
The bytes for description to set.
|
Returns
setDisplayName(String value)
public Taxonomy.Builder setDisplayName(String value)
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];
| Name | Description |
| value | String
The displayName to set.
|
Returns
setDisplayNameBytes(ByteString value)
public Taxonomy.Builder setDisplayNameBytes(ByteString value)
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];
| Name | Description |
| value | ByteString
The bytes for displayName to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public Taxonomy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setName(String value)
public Taxonomy.Builder setName(String value)
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];
| Name | Description |
| value | String
The name to set.
|
Returns
setNameBytes(ByteString value)
public Taxonomy.Builder setNameBytes(ByteString value)
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];
| Name | Description |
| value | ByteString
The bytes for name to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Taxonomy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Taxonomy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
