Class Taxonomy.Builder 

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Taxonomy.Builder

Implements

TaxonomyOrBuilder

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
Name Description
value Taxonomy.PolicyType

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

Parameter
Name Description
value int

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.datacatalog.v1.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.v1.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
Overrides

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
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
Type Description
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
Type Description
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.

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
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
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
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
Type Description
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
Type Description
Taxonomy.Builder

clone()

public Taxonomy.Builder clone()
Returns
Type Description
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
Name Description
index int

The 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.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()
Returns
Type Description
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
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.

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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.

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.

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 in URL format.
 Note: Policy tag manager generates unique taxonomy IDs.

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 in URL format.
 Note: Policy tag manager generates unique taxonomy IDs.

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

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

Whether the taxonomyTimestamps field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

public Taxonomy.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
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
Name Description
value SystemTimestamps
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
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
Name Description
index int

The index to set the value at.
value Taxonomy.PolicyType

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

Parameters
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. 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
Name Description
value String

The 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. 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
Name Description
value ByteString

The 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.
 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.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The 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.
 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.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The 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
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
Name Description
value String

The 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 in URL format.
 Note: Policy tag manager generates unique taxonomy IDs.

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
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
Name Description
value int

The policyTagCount 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
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
Name Description
value SystemTimestamps
Returns
Type Description
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
Name Description
builderForValue SystemTimestamps.Builder
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
Overrides