Class DataTaxonomy.Builder (1.46.0)

public static final class DataTaxonomy.Builder extends GeneratedMessageV3.Builder<DataTaxonomy.Builder> implements DataTaxonomyOrBuilder

DataTaxonomy represents a set of hierarchical DataAttributes resources, grouped with a common theme Eg: 'SensitiveDataTaxonomy' can have attributes to manage PII data. It is defined at project level.

Protobuf type google.cloud.dataplex.v1.DataTaxonomy

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DataTaxonomy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DataTaxonomy.Builder
Overrides

build()

public DataTaxonomy build()
Returns
Type Description
DataTaxonomy

buildPartial()

public DataTaxonomy buildPartial()
Returns
Type Description
DataTaxonomy

clear()

public DataTaxonomy.Builder clear()
Returns
Type Description
DataTaxonomy.Builder
Overrides

clearAttributeCount()

public DataTaxonomy.Builder clearAttributeCount()

Output only. The number of attributes in the DataTaxonomy.

int32 attribute_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

clearClassCount()

public DataTaxonomy.Builder clearClassCount()

Output only. The number of classes in the DataTaxonomy.

int32 class_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

clearCreateTime()

public DataTaxonomy.Builder clearCreateTime()

Output only. The time when the DataTaxonomy was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataTaxonomy.Builder

clearDescription()

public DataTaxonomy.Builder clearDescription()

Optional. Description of the DataTaxonomy.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

clearDisplayName()

public DataTaxonomy.Builder clearDisplayName()

Optional. User friendly display name.

string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

clearEtag()

public DataTaxonomy.Builder clearEtag()

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 10;

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DataTaxonomy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DataTaxonomy.Builder
Overrides

clearLabels()

public DataTaxonomy.Builder clearLabels()
Returns
Type Description
DataTaxonomy.Builder

clearName()

public DataTaxonomy.Builder clearName()

Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DataTaxonomy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DataTaxonomy.Builder
Overrides

clearUid()

public DataTaxonomy.Builder clearUid()

Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

clearUpdateTime()

public DataTaxonomy.Builder clearUpdateTime()

Output only. The time when the DataTaxonomy was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataTaxonomy.Builder

clone()

public DataTaxonomy.Builder clone()
Returns
Type Description
DataTaxonomy.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

Optional. User-defined labels for the DataTaxonomy.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getAttributeCount()

public int getAttributeCount()

Output only. The number of attributes in the DataTaxonomy.

int32 attribute_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The attributeCount.

getClassCount()

public int getClassCount()

Output only. The number of classes in the DataTaxonomy.

int32 class_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The classCount.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the DataTaxonomy was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the DataTaxonomy was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the DataTaxonomy was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public DataTaxonomy getDefaultInstanceForType()
Returns
Type Description
DataTaxonomy

getDescription()

public String getDescription()

Optional. Description of the DataTaxonomy.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the DataTaxonomy.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Optional. User friendly display name.

string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. User friendly display name.

string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 10;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 10;

Returns
Type Description
ByteString

The bytes for etag.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. User-defined labels for the DataTaxonomy.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. User-defined labels for the DataTaxonomy.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. User-defined labels for the DataTaxonomy.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. User-defined labels for the DataTaxonomy.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getUid()

public String getUid()

Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time when the DataTaxonomy was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The time when the DataTaxonomy was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time when the DataTaxonomy was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the DataTaxonomy was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time when the DataTaxonomy was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public DataTaxonomy.Builder mergeCreateTime(Timestamp value)

Output only. The time when the DataTaxonomy was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataTaxonomy.Builder

mergeFrom(DataTaxonomy other)

public DataTaxonomy.Builder mergeFrom(DataTaxonomy other)
Parameter
Name Description
other DataTaxonomy
Returns
Type Description
DataTaxonomy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataTaxonomy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataTaxonomy.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DataTaxonomy.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DataTaxonomy.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DataTaxonomy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DataTaxonomy.Builder
Overrides

mergeUpdateTime(Timestamp value)

public DataTaxonomy.Builder mergeUpdateTime(Timestamp value)

Output only. The time when the DataTaxonomy was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataTaxonomy.Builder

putAllLabels(Map<String,String> values)

public DataTaxonomy.Builder putAllLabels(Map<String,String> values)

Optional. User-defined labels for the DataTaxonomy.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
DataTaxonomy.Builder

putLabels(String key, String value)

public DataTaxonomy.Builder putLabels(String key, String value)

Optional. User-defined labels for the DataTaxonomy.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
DataTaxonomy.Builder

removeLabels(String key)

public DataTaxonomy.Builder removeLabels(String key)

Optional. User-defined labels for the DataTaxonomy.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
DataTaxonomy.Builder

setAttributeCount(int value)

public DataTaxonomy.Builder setAttributeCount(int value)

Output only. The number of attributes in the DataTaxonomy.

int32 attribute_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The attributeCount to set.

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

setClassCount(int value)

public DataTaxonomy.Builder setClassCount(int value)

Output only. The number of classes in the DataTaxonomy.

int32 class_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The classCount to set.

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public DataTaxonomy.Builder setCreateTime(Timestamp value)

Output only. The time when the DataTaxonomy was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataTaxonomy.Builder

setCreateTime(Timestamp.Builder builderForValue)

public DataTaxonomy.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time when the DataTaxonomy was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataTaxonomy.Builder

setDescription(String value)

public DataTaxonomy.Builder setDescription(String value)

Optional. Description of the DataTaxonomy.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public DataTaxonomy.Builder setDescriptionBytes(ByteString value)

Optional. Description of the DataTaxonomy.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

setDisplayName(String value)

public DataTaxonomy.Builder setDisplayName(String value)

Optional. User friendly display name.

string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public DataTaxonomy.Builder setDisplayNameBytes(ByteString value)

Optional. User friendly display name.

string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

setEtag(String value)

public DataTaxonomy.Builder setEtag(String value)

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 10;

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public DataTaxonomy.Builder setEtagBytes(ByteString value)

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 10;

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DataTaxonomy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DataTaxonomy.Builder
Overrides

setName(String value)

public DataTaxonomy.Builder setName(String value)

Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DataTaxonomy.Builder setNameBytes(ByteString value)

Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DataTaxonomy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DataTaxonomy.Builder
Overrides

setUid(String value)

public DataTaxonomy.Builder setUid(String value)

Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The uid to set.

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

setUidBytes(ByteString value)

public DataTaxonomy.Builder setUidBytes(ByteString value)

Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for uid to set.

Returns
Type Description
DataTaxonomy.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DataTaxonomy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DataTaxonomy.Builder
Overrides

setUpdateTime(Timestamp value)

public DataTaxonomy.Builder setUpdateTime(Timestamp value)

Output only. The time when the DataTaxonomy was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataTaxonomy.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public DataTaxonomy.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time when the DataTaxonomy was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataTaxonomy.Builder