Class DataAttribute.Builder (1.30.0)

public static final class DataAttribute.Builder extends GeneratedMessageV3.Builder<DataAttribute.Builder> implements DataAttributeOrBuilder

Denotes one dataAttribute in a dataTaxonomy, for example, PII. DataAttribute resources can be defined in a hierarchy. A single dataAttribute resource can contain specs of multiple types

` PII

  • ResourceAccessSpec :
    • readers :foo@bar.com
  • DataAccessSpec :
    • readers :bar@foo.com
`

Protobuf type google.cloud.dataplex.v1.DataAttribute

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DataAttribute.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DataAttribute.Builder
Overrides

build()

public DataAttribute build()
Returns
TypeDescription
DataAttribute

buildPartial()

public DataAttribute buildPartial()
Returns
TypeDescription
DataAttribute

clear()

public DataAttribute.Builder clear()
Returns
TypeDescription
DataAttribute.Builder
Overrides

clearAttributeCount()

public DataAttribute.Builder clearAttributeCount()

Output only. The number of child attributes present for this attribute.

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

Returns
TypeDescription
DataAttribute.Builder

This builder for chaining.

clearCreateTime()

public DataAttribute.Builder clearCreateTime()

Output only. The time when the DataAttribute was created.

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

Returns
TypeDescription
DataAttribute.Builder

clearDataAccessSpec()

public DataAttribute.Builder clearDataAccessSpec()

Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).

.google.cloud.dataplex.v1.DataAccessSpec data_access_spec = 101 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DataAttribute.Builder

clearDescription()

public DataAttribute.Builder clearDescription()

Optional. Description of the DataAttribute.

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

Returns
TypeDescription
DataAttribute.Builder

This builder for chaining.

clearDisplayName()

public DataAttribute.Builder clearDisplayName()

Optional. User friendly display name.

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

Returns
TypeDescription
DataAttribute.Builder

This builder for chaining.

clearEtag()

public DataAttribute.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
TypeDescription
DataAttribute.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DataAttribute.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DataAttribute.Builder
Overrides

clearLabels()

public DataAttribute.Builder clearLabels()
Returns
TypeDescription
DataAttribute.Builder

clearName()

public DataAttribute.Builder clearName()

Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.

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

Returns
TypeDescription
DataAttribute.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DataAttribute.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DataAttribute.Builder
Overrides

clearParentId()

public DataAttribute.Builder clearParentId()

Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. [a -> b -> c -> d -> e, depth = 4]

string parent_id = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
DataAttribute.Builder

This builder for chaining.

clearResourceAccessSpec()

public DataAttribute.Builder clearResourceAccessSpec()

Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).

.google.cloud.dataplex.v1.ResourceAccessSpec resource_access_spec = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DataAttribute.Builder

clearUid()

public DataAttribute.Builder clearUid()

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

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

Returns
TypeDescription
DataAttribute.Builder

This builder for chaining.

clearUpdateTime()

public DataAttribute.Builder clearUpdateTime()

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

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

Returns
TypeDescription
DataAttribute.Builder

clone()

public DataAttribute.Builder clone()
Returns
TypeDescription
DataAttribute.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

Optional. User-defined labels for the DataAttribute.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getAttributeCount()

public int getAttributeCount()

Output only. The number of child attributes present for this attribute.

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

Returns
TypeDescription
int

The attributeCount.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the DataAttribute was created.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the DataAttribute was created.

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

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the DataAttribute was created.

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

Returns
TypeDescription
TimestampOrBuilder

getDataAccessSpec()

public DataAccessSpec getDataAccessSpec()

Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).

.google.cloud.dataplex.v1.DataAccessSpec data_access_spec = 101 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DataAccessSpec

The dataAccessSpec.

getDataAccessSpecBuilder()

public DataAccessSpec.Builder getDataAccessSpecBuilder()

Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).

.google.cloud.dataplex.v1.DataAccessSpec data_access_spec = 101 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DataAccessSpec.Builder

getDataAccessSpecOrBuilder()

public DataAccessSpecOrBuilder getDataAccessSpecOrBuilder()

Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).

.google.cloud.dataplex.v1.DataAccessSpec data_access_spec = 101 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DataAccessSpecOrBuilder

getDefaultInstanceForType()

public DataAttribute getDefaultInstanceForType()
Returns
TypeDescription
DataAttribute

getDescription()

public String getDescription()

Optional. Description of the DataAttribute.

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

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the DataAttribute.

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

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Optional. User friendly display name.

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

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. User friendly display name.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for etag.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. User-defined labels for the DataAttribute.

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

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. User-defined labels for the DataAttribute.

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

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. User-defined labels for the DataAttribute.

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

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. User-defined labels for the DataAttribute.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String getName()

Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.

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

Returns
TypeDescription
ByteString

The bytes for name.

getParentId()

public String getParentId()

Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. [a -> b -> c -> d -> e, depth = 4]

string parent_id = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parentId.

getParentIdBytes()

public ByteString getParentIdBytes()

Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. [a -> b -> c -> d -> e, depth = 4]

string parent_id = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parentId.

getResourceAccessSpec()

public ResourceAccessSpec getResourceAccessSpec()

Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).

.google.cloud.dataplex.v1.ResourceAccessSpec resource_access_spec = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ResourceAccessSpec

The resourceAccessSpec.

getResourceAccessSpecBuilder()

public ResourceAccessSpec.Builder getResourceAccessSpecBuilder()

Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).

.google.cloud.dataplex.v1.ResourceAccessSpec resource_access_spec = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ResourceAccessSpec.Builder

getResourceAccessSpecOrBuilder()

public ResourceAccessSpecOrBuilder getResourceAccessSpecOrBuilder()

Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).

.google.cloud.dataplex.v1.ResourceAccessSpec resource_access_spec = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ResourceAccessSpecOrBuilder

getUid()

public String getUid()

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

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

Returns
TypeDescription
String

The uid.

getUidBytes()

public ByteString getUidBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

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

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

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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

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

Returns
TypeDescription
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the DataAttribute was created.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasDataAccessSpec()

public boolean hasDataAccessSpec()

Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).

.google.cloud.dataplex.v1.DataAccessSpec data_access_spec = 101 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the dataAccessSpec field is set.

hasResourceAccessSpec()

public boolean hasResourceAccessSpec()

Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).

.google.cloud.dataplex.v1.ResourceAccessSpec resource_access_spec = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the resourceAccessSpec field is set.

hasUpdateTime()

public boolean hasUpdateTime()

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

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

Returns
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

public DataAttribute.Builder mergeCreateTime(Timestamp value)

Output only. The time when the DataAttribute was created.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
DataAttribute.Builder

mergeDataAccessSpec(DataAccessSpec value)

public DataAttribute.Builder mergeDataAccessSpec(DataAccessSpec value)

Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).

.google.cloud.dataplex.v1.DataAccessSpec data_access_spec = 101 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueDataAccessSpec
Returns
TypeDescription
DataAttribute.Builder

mergeFrom(DataAttribute other)

public DataAttribute.Builder mergeFrom(DataAttribute other)
Parameter
NameDescription
otherDataAttribute
Returns
TypeDescription
DataAttribute.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataAttribute.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataAttribute.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DataAttribute.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DataAttribute.Builder
Overrides

mergeResourceAccessSpec(ResourceAccessSpec value)

public DataAttribute.Builder mergeResourceAccessSpec(ResourceAccessSpec value)

Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).

.google.cloud.dataplex.v1.ResourceAccessSpec resource_access_spec = 100 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueResourceAccessSpec
Returns
TypeDescription
DataAttribute.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DataAttribute.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DataAttribute.Builder
Overrides

mergeUpdateTime(Timestamp value)

public DataAttribute.Builder mergeUpdateTime(Timestamp value)

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

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
DataAttribute.Builder

putAllLabels(Map<String,String> values)

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

Optional. User-defined labels for the DataAttribute.

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

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
DataAttribute.Builder

putLabels(String key, String value)

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

Optional. User-defined labels for the DataAttribute.

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

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
DataAttribute.Builder

removeLabels(String key)

public DataAttribute.Builder removeLabels(String key)

Optional. User-defined labels for the DataAttribute.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
DataAttribute.Builder

setAttributeCount(int value)

public DataAttribute.Builder setAttributeCount(int value)

Output only. The number of child attributes present for this attribute.

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

Parameter
NameDescription
valueint

The attributeCount to set.

Returns
TypeDescription
DataAttribute.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public DataAttribute.Builder setCreateTime(Timestamp value)

Output only. The time when the DataAttribute was created.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
DataAttribute.Builder

setCreateTime(Timestamp.Builder builderForValue)

public DataAttribute.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time when the DataAttribute was created.

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
DataAttribute.Builder

setDataAccessSpec(DataAccessSpec value)

public DataAttribute.Builder setDataAccessSpec(DataAccessSpec value)

Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).

.google.cloud.dataplex.v1.DataAccessSpec data_access_spec = 101 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueDataAccessSpec
Returns
TypeDescription
DataAttribute.Builder

setDataAccessSpec(DataAccessSpec.Builder builderForValue)

public DataAttribute.Builder setDataAccessSpec(DataAccessSpec.Builder builderForValue)

Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).

.google.cloud.dataplex.v1.DataAccessSpec data_access_spec = 101 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValueDataAccessSpec.Builder
Returns
TypeDescription
DataAttribute.Builder

setDescription(String value)

public DataAttribute.Builder setDescription(String value)

Optional. Description of the DataAttribute.

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

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
DataAttribute.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public DataAttribute.Builder setDescriptionBytes(ByteString value)

Optional. Description of the DataAttribute.

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

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
DataAttribute.Builder

This builder for chaining.

setDisplayName(String value)

public DataAttribute.Builder setDisplayName(String value)

Optional. User friendly display name.

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

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
DataAttribute.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public DataAttribute.<