public static final class Taxonomy.Builder extends GeneratedMessageV3.Builder<Taxonomy.Builder> implements TaxonomyOrBuilderA 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Taxonomy.BuilderImplements
TaxonomyOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Taxonomy.PolicyTypeThe activatedPolicyTypes to add. |
| Returns | |
|---|---|
| Type | Description |
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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for activatedPolicyTypes to add. |
| Returns | |
|---|---|
| Type | Description |
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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.datacatalog.v1beta1.Taxonomy.PolicyType>The activatedPolicyTypes to add. |
| Returns | |
|---|---|
| Type | Description |
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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<Integer>The enum numeric values on the wire for activatedPolicyTypes to add. |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Taxonomy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
|
build()
public Taxonomy build()| Returns | |
|---|---|
| Type | Description |
Taxonomy |
|
buildPartial()
public Taxonomy buildPartial()| Returns | |
|---|---|
| Type | Description |
Taxonomy |
|
clear()
public Taxonomy.Builder clear()| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
This builder for chaining. |
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];
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
This builder for chaining. |
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];
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Taxonomy.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Taxonomy.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
|
clone()
public Taxonomy.Builder clone()| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
|
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];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
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.v1beta1.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.v1beta1.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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe 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];
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for activatedPolicyTypes. |
getDefaultInstanceForType()
public Taxonomy getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Taxonomy |
|
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];
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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];
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getName()
public String 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];
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Taxonomy other)
public Taxonomy.Builder mergeFrom(Taxonomy other)| Parameter | |
|---|---|
| Name | Description |
other |
Taxonomy |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Taxonomy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Taxonomy.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Taxonomy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
|
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];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
Taxonomy.PolicyTypeThe activatedPolicyTypes to set. |
| Returns | |
|---|---|
| Type | Description |
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.v1beta1.Taxonomy.PolicyType activated_policy_types = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
intThe enum numeric value on the wire for activatedPolicyTypes to set. |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
This builder for chaining. |
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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
This builder for chaining. |
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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
This builder for chaining. |
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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
This builder for chaining. |
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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Taxonomy.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
|
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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
This builder for chaining. |
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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Taxonomy.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Taxonomy.Builder |
|