Class DataScan.Builder (0.16.0)

public static final class DataScan.Builder extends GeneratedMessageV3.Builder<DataScan.Builder> implements DataScanOrBuilder

Represents a user-visible job which provides the insights for the related data source. For example:

Data Quality: generates queries based on the rules and runs against the data to get data quality check results.
Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc).

Protobuf type google.events.cloud.dataplex.v1.DataScan

Inheritance

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

Implements

DataScanOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DataScan.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DataScan.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public DataScan build()

Returns
Type	Description
`DataScan`

buildPartial()

public DataScan buildPartial()

Returns
Type	Description
`DataScan`

clear()

public DataScan.Builder clear()

Returns
Type	Description
`DataScan.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCreateTime()

public DataScan.Builder clearCreateTime()

Output only. The time when the scan was created.

.google.protobuf.Timestamp create_time = 7;

Returns
Type	Description
`DataScan.Builder`

clearData()

public DataScan.Builder clearData()

Required. The data source for DataScan.

.google.events.cloud.dataplex.v1.DataSource data = 9;

Returns
Type	Description
`DataScan.Builder`

clearDataProfileResult()

public DataScan.Builder clearDataProfileResult()

Output only. The result of the data profile scan.

.google.events.cloud.dataplex.v1.DataProfileResult data_profile_result = 201;

Returns
Type	Description
`DataScan.Builder`

clearDataProfileSpec()

public DataScan.Builder clearDataProfileSpec()

DataProfileScan related setting.

.google.events.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;

Returns
Type	Description
`DataScan.Builder`

clearDataQualityResult()

public DataScan.Builder clearDataQualityResult()

Output only. The result of the data quality scan.

.google.events.cloud.dataplex.v1.DataQualityResult data_quality_result = 200;

Returns
Type	Description
`DataScan.Builder`

clearDataQualitySpec()

public DataScan.Builder clearDataQualitySpec()

DataQualityScan related setting.

.google.events.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;

Returns
Type	Description
`DataScan.Builder`

clearDescription()

public DataScan.Builder clearDescription()

Optional. Description of the scan.

Must be between 1-1024 characters.

string description = 3;

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

clearDisplayName()

public DataScan.Builder clearDisplayName()

Optional. User friendly display name.

Must be between 1-256 characters.

string display_name = 4;

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

clearExecutionSpec()

public DataScan.Builder clearExecutionSpec()

Optional. DataScan execution settings. If not specified, the fields in it will use their default values.

.google.events.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10;

Returns
Type	Description
`DataScan.Builder`

clearExecutionStatus()

public DataScan.Builder clearExecutionStatus()

Output only. Status of the data scan execution.

.google.events.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11;

Returns
Type	Description
`DataScan.Builder`

clearField(Descriptors.FieldDescriptor field)

public DataScan.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`DataScan.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearLabels()

public DataScan.Builder clearLabels()

Returns
Type	Description
`DataScan.Builder`

clearName()

public DataScan.Builder clearName()

Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.

string name = 1;

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DataScan.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`DataScan.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearResult()

public DataScan.Builder clearResult()

Returns
Type	Description
`DataScan.Builder`

clearSpec()

public DataScan.Builder clearSpec()

Returns
Type	Description
`DataScan.Builder`

clearState()

public DataScan.Builder clearState()

Output only. Current state of the DataScan.

.google.events.cloud.dataplex.v1.State state = 6;

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

clearType()

public DataScan.Builder clearType()

Output only. The type of DataScan.

.google.events.cloud.dataplex.v1.DataScanType type = 12;

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

clearUid()

public DataScan.Builder clearUid()

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

string uid = 2;

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

clearUpdateTime()

public DataScan.Builder clearUpdateTime()

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

.google.protobuf.Timestamp update_time = 8;

Returns
Type	Description
`DataScan.Builder`

clone()

public DataScan.Builder clone()

Returns
Type	Description
`DataScan.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsLabels(String key)

public boolean containsLabels(String key)

Optional. User-defined labels for the scan.

map<string, string> labels = 5;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the scan was created.

.google.protobuf.Timestamp create_time = 7;

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the scan was created.

.google.protobuf.Timestamp create_time = 7;

Returns
Type	Description
`Builder`

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the scan was created.

.google.protobuf.Timestamp create_time = 7;

Returns
Type	Description
`TimestampOrBuilder`

getData()

public DataSource getData()

Required. The data source for DataScan.

.google.events.cloud.dataplex.v1.DataSource data = 9;

Returns
Type	Description
`DataSource`	The data.

getDataBuilder()

public DataSource.Builder getDataBuilder()

Required. The data source for DataScan.

.google.events.cloud.dataplex.v1.DataSource data = 9;

Returns
Type	Description
`DataSource.Builder`

getDataOrBuilder()

public DataSourceOrBuilder getDataOrBuilder()

Required. The data source for DataScan.

.google.events.cloud.dataplex.v1.DataSource data = 9;

Returns
Type	Description
`DataSourceOrBuilder`

getDataProfileResult()

public DataProfileResult getDataProfileResult()

Output only. The result of the data profile scan.

.google.events.cloud.dataplex.v1.DataProfileResult data_profile_result = 201;

Returns
Type	Description
`DataProfileResult`	The dataProfileResult.

getDataProfileResultBuilder()

public DataProfileResult.Builder getDataProfileResultBuilder()

Output only. The result of the data profile scan.

.google.events.cloud.dataplex.v1.DataProfileResult data_profile_result = 201;

Returns
Type	Description
`DataProfileResult.Builder`

getDataProfileResultOrBuilder()

public DataProfileResultOrBuilder getDataProfileResultOrBuilder()

Output only. The result of the data profile scan.

.google.events.cloud.dataplex.v1.DataProfileResult data_profile_result = 201;

Returns
Type	Description
`DataProfileResultOrBuilder`

getDataProfileSpec()

public DataProfileSpec getDataProfileSpec()

DataProfileScan related setting.

.google.events.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;

Returns
Type	Description
`DataProfileSpec`	The dataProfileSpec.

getDataProfileSpecBuilder()

public DataProfileSpec.Builder getDataProfileSpecBuilder()

DataProfileScan related setting.

.google.events.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;

Returns
Type	Description
`DataProfileSpec.Builder`

getDataProfileSpecOrBuilder()

public DataProfileSpecOrBuilder getDataProfileSpecOrBuilder()

DataProfileScan related setting.

.google.events.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;

Returns
Type	Description
`DataProfileSpecOrBuilder`

getDataQualityResult()

public DataQualityResult getDataQualityResult()

Output only. The result of the data quality scan.

.google.events.cloud.dataplex.v1.DataQualityResult data_quality_result = 200;

Returns
Type	Description
`DataQualityResult`	The dataQualityResult.

getDataQualityResultBuilder()

public DataQualityResult.Builder getDataQualityResultBuilder()

Output only. The result of the data quality scan.

.google.events.cloud.dataplex.v1.DataQualityResult data_quality_result = 200;

Returns
Type	Description
`DataQualityResult.Builder`

getDataQualityResultOrBuilder()

public DataQualityResultOrBuilder getDataQualityResultOrBuilder()

Output only. The result of the data quality scan.

.google.events.cloud.dataplex.v1.DataQualityResult data_quality_result = 200;

Returns
Type	Description
`DataQualityResultOrBuilder`

getDataQualitySpec()

public DataQualitySpec getDataQualitySpec()

DataQualityScan related setting.

.google.events.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;

Returns
Type	Description
`DataQualitySpec`	The dataQualitySpec.

getDataQualitySpecBuilder()

public DataQualitySpec.Builder getDataQualitySpecBuilder()

DataQualityScan related setting.

.google.events.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;

Returns
Type	Description
`DataQualitySpec.Builder`

getDataQualitySpecOrBuilder()

public DataQualitySpecOrBuilder getDataQualitySpecOrBuilder()

DataQualityScan related setting.

.google.events.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;

Returns
Type	Description
`DataQualitySpecOrBuilder`

getDefaultInstanceForType()

public DataScan getDefaultInstanceForType()

Returns
Type	Description
`DataScan`

getDescription()

public String getDescription()

Optional. Description of the scan.

Must be between 1-1024 characters.

string description = 3;

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the scan.

Must be between 1-1024 characters.

string description = 3;

Returns
Type	Description
`ByteString`	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

Optional. User friendly display name.

Must be between 1-256 characters.

string display_name = 4;

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. User friendly display name.

Must be between 1-256 characters.

string display_name = 4;

Returns
Type	Description
`ByteString`	The bytes for displayName.

getExecutionSpec()

public DataScan.ExecutionSpec getExecutionSpec()

Optional. DataScan execution settings. If not specified, the fields in it will use their default values.

.google.events.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10;

Returns
Type	Description
`DataScan.ExecutionSpec`	The executionSpec.

getExecutionSpecBuilder()

public DataScan.ExecutionSpec.Builder getExecutionSpecBuilder()

Optional. DataScan execution settings. If not specified, the fields in it will use their default values.

.google.events.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10;

Returns
Type	Description
`DataScan.ExecutionSpec.Builder`

getExecutionSpecOrBuilder()

public DataScan.ExecutionSpecOrBuilder getExecutionSpecOrBuilder()

Optional. DataScan execution settings. If not specified, the fields in it will use their default values.

.google.events.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10;

Returns
Type	Description
`DataScan.ExecutionSpecOrBuilder`

getExecutionStatus()

public DataScan.ExecutionStatus getExecutionStatus()

Output only. Status of the data scan execution.

.google.events.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11;

Returns
Type	Description
`DataScan.ExecutionStatus`	The executionStatus.

getExecutionStatusBuilder()

public DataScan.ExecutionStatus.Builder getExecutionStatusBuilder()

Output only. Status of the data scan execution.

.google.events.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11;

Returns
Type	Description
`DataScan.ExecutionStatus.Builder`

getExecutionStatusOrBuilder()

public DataScan.ExecutionStatusOrBuilder getExecutionStatusOrBuilder()

Output only. Status of the data scan execution.

.google.events.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11;

Returns
Type	Description
`DataScan.ExecutionStatusOrBuilder`

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public int getLabelsCount()

Optional. User-defined labels for the scan.

map<string, string> labels = 5;

Returns
Type	Description
`int`

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. User-defined labels for the scan.

map<string, string> labels = 5;

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. User-defined labels for the scan.

map<string, string> labels = 5;

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

map<string, string> labels = 5;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,String>`

getName()

public String getName()

string name = 1;

Returns
Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

string name = 1;

Returns
Type	Description
`ByteString`	The bytes for name.

getResultCase()

public DataScan.ResultCase getResultCase()

Returns
Type	Description
`DataScan.ResultCase`

getSpecCase()

public DataScan.SpecCase getSpecCase()

Returns
Type	Description
`DataScan.SpecCase`

getState()

public State getState()

Output only. Current state of the DataScan.

.google.events.cloud.dataplex.v1.State state = 6;

Returns
Type	Description
`State`	The state.

getStateValue()

public int getStateValue()

Output only. Current state of the DataScan.

.google.events.cloud.dataplex.v1.State state = 6;

Returns
Type	Description
`int`	The enum numeric value on the wire for state.

getType()

public DataScanType getType()

Output only. The type of DataScan.

.google.events.cloud.dataplex.v1.DataScanType type = 12;

Returns
Type	Description
`DataScanType`	The type.

getTypeValue()

public int getTypeValue()

Output only. The type of DataScan.

.google.events.cloud.dataplex.v1.DataScanType type = 12;

Returns
Type	Description
`int`	The enum numeric value on the wire for type.

getUid()

public String getUid()

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

string uid = 2;

Returns
Type	Description
`String`	The uid.

getUidBytes()

public ByteString getUidBytes()

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

string uid = 2;

Returns
Type	Description
`ByteString`	The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

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

.google.protobuf.Timestamp update_time = 8;

Returns
Type	Description
`Timestamp`	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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

.google.protobuf.Timestamp update_time = 8;

Returns
Type	Description
`Builder`

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 8;

Returns
Type	Description
`TimestampOrBuilder`

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the scan was created.

.google.protobuf.Timestamp create_time = 7;

Returns
Type	Description
`boolean`	Whether the createTime field is set.

hasData()

public boolean hasData()

Required. The data source for DataScan.

.google.events.cloud.dataplex.v1.DataSource data = 9;

Returns
Type	Description
`boolean`	Whether the data field is set.

hasDataProfileResult()

public boolean hasDataProfileResult()

Output only. The result of the data profile scan.

.google.events.cloud.dataplex.v1.DataProfileResult data_profile_result = 201;

Returns
Type	Description
`boolean`	Whether the dataProfileResult field is set.

hasDataProfileSpec()

public boolean hasDataProfileSpec()

DataProfileScan related setting.

.google.events.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;

Returns
Type	Description
`boolean`	Whether the dataProfileSpec field is set.

hasDataQualityResult()

public boolean hasDataQualityResult()

Output only. The result of the data quality scan.

.google.events.cloud.dataplex.v1.DataQualityResult data_quality_result = 200;

Returns
Type	Description
`boolean`	Whether the dataQualityResult field is set.

hasDataQualitySpec()

public boolean hasDataQualitySpec()

DataQualityScan related setting.

.google.events.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;

Returns
Type	Description
`boolean`	Whether the dataQualitySpec field is set.

hasExecutionSpec()

public boolean hasExecutionSpec()

Optional. DataScan execution settings. If not specified, the fields in it will use their default values.

.google.events.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10;

Returns
Type	Description
`boolean`	Whether the executionSpec field is set.

hasExecutionStatus()

public boolean hasExecutionStatus()

Output only. Status of the data scan execution.

.google.events.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11;

Returns
Type	Description
`boolean`	Whether the executionStatus field is set.

hasUpdateTime()

public boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 8;

Returns
Type	Description
`boolean`	Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

public DataScan.Builder mergeCreateTime(Timestamp value)

Output only. The time when the scan was created.

.google.protobuf.Timestamp create_time = 7;

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`DataScan.Builder`

mergeData(DataSource value)

public DataScan.Builder mergeData(DataSource value)

Required. The data source for DataScan.

.google.events.cloud.dataplex.v1.DataSource data = 9;

Parameter
Name	Description
`value`	`DataSource`

Returns
Type	Description
`DataScan.Builder`

mergeDataProfileResult(DataProfileResult value)

public DataScan.Builder mergeDataProfileResult(DataProfileResult value)

Output only. The result of the data profile scan.

.google.events.cloud.dataplex.v1.DataProfileResult data_profile_result = 201;

Parameter
Name	Description
`value`	`DataProfileResult`

Returns
Type	Description
`DataScan.Builder`

mergeDataProfileSpec(DataProfileSpec value)

public DataScan.Builder mergeDataProfileSpec(DataProfileSpec value)

DataProfileScan related setting.

.google.events.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;

Parameter
Name	Description
`value`	`DataProfileSpec`

Returns
Type	Description
`DataScan.Builder`

mergeDataQualityResult(DataQualityResult value)

public DataScan.Builder mergeDataQualityResult(DataQualityResult value)

Output only. The result of the data quality scan.

.google.events.cloud.dataplex.v1.DataQualityResult data_quality_result = 200;

Parameter
Name	Description
`value`	`DataQualityResult`

Returns
Type	Description
`DataScan.Builder`

mergeDataQualitySpec(DataQualitySpec value)

public DataScan.Builder mergeDataQualitySpec(DataQualitySpec value)

DataQualityScan related setting.

.google.events.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;

Parameter
Name	Description
`value`	`DataQualitySpec`

Returns
Type	Description
`DataScan.Builder`

mergeExecutionSpec(DataScan.ExecutionSpec value)

public DataScan.Builder mergeExecutionSpec(DataScan.ExecutionSpec value)

Optional. DataScan execution settings. If not specified, the fields in it will use their default values.

.google.events.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10;

Parameter
Name	Description
`value`	`DataScan.ExecutionSpec`

Returns
Type	Description
`DataScan.Builder`

mergeExecutionStatus(DataScan.ExecutionStatus value)

public DataScan.Builder mergeExecutionStatus(DataScan.ExecutionStatus value)

Output only. Status of the data scan execution.

.google.events.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11;

Parameter
Name	Description
`value`	`DataScan.ExecutionStatus`

Returns
Type	Description
`DataScan.Builder`

mergeFrom(DataScan other)

public DataScan.Builder mergeFrom(DataScan other)

Parameter
Name	Description
`other`	`DataScan`

Returns
Type	Description
`DataScan.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataScan.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DataScan.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public DataScan.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`DataScan.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DataScan.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DataScan.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public DataScan.Builder mergeUpdateTime(Timestamp value)

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

.google.protobuf.Timestamp update_time = 8;

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`DataScan.Builder`

putAllLabels(Map<String,String> values)

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

Optional. User-defined labels for the scan.

map<string, string> labels = 5;

Parameter
Name	Description
`values`	`Map<String,String>`

Returns
Type	Description
`DataScan.Builder`

putLabels(String key, String value)

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

Optional. User-defined labels for the scan.

map<string, string> labels = 5;

Parameters
Name	Description
`key`	`String`
`value`	`String`

Returns
Type	Description
`DataScan.Builder`

removeLabels(String key)

public DataScan.Builder removeLabels(String key)

Optional. User-defined labels for the scan.

map<string, string> labels = 5;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`DataScan.Builder`

setCreateTime(Timestamp value)

public DataScan.Builder setCreateTime(Timestamp value)

Output only. The time when the scan was created.

.google.protobuf.Timestamp create_time = 7;

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`DataScan.Builder`

setCreateTime(Timestamp.Builder builderForValue)

public DataScan.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time when the scan was created.

.google.protobuf.Timestamp create_time = 7;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`DataScan.Builder`

setData(DataSource value)

public DataScan.Builder setData(DataSource value)

Required. The data source for DataScan.

.google.events.cloud.dataplex.v1.DataSource data = 9;

Parameter
Name	Description
`value`	`DataSource`

Returns
Type	Description
`DataScan.Builder`

setData(DataSource.Builder builderForValue)

public DataScan.Builder setData(DataSource.Builder builderForValue)

Required. The data source for DataScan.

.google.events.cloud.dataplex.v1.DataSource data = 9;

Parameter
Name	Description
`builderForValue`	`DataSource.Builder`

Returns
Type	Description
`DataScan.Builder`

setDataProfileResult(DataProfileResult value)

public DataScan.Builder setDataProfileResult(DataProfileResult value)

Output only. The result of the data profile scan.

.google.events.cloud.dataplex.v1.DataProfileResult data_profile_result = 201;

Parameter
Name	Description
`value`	`DataProfileResult`

Returns
Type	Description
`DataScan.Builder`

setDataProfileResult(DataProfileResult.Builder builderForValue)

public DataScan.Builder setDataProfileResult(DataProfileResult.Builder builderForValue)

Output only. The result of the data profile scan.

.google.events.cloud.dataplex.v1.DataProfileResult data_profile_result = 201;

Parameter
Name	Description
`builderForValue`	`DataProfileResult.Builder`

Returns
Type	Description
`DataScan.Builder`

setDataProfileSpec(DataProfileSpec value)

public DataScan.Builder setDataProfileSpec(DataProfileSpec value)

DataProfileScan related setting.

.google.events.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;

Parameter
Name	Description
`value`	`DataProfileSpec`

Returns
Type	Description
`DataScan.Builder`

setDataProfileSpec(DataProfileSpec.Builder builderForValue)

public DataScan.Builder setDataProfileSpec(DataProfileSpec.Builder builderForValue)

DataProfileScan related setting.

.google.events.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;

Parameter
Name	Description
`builderForValue`	`DataProfileSpec.Builder`

Returns
Type	Description
`DataScan.Builder`

setDataQualityResult(DataQualityResult value)

public DataScan.Builder setDataQualityResult(DataQualityResult value)

Output only. The result of the data quality scan.

.google.events.cloud.dataplex.v1.DataQualityResult data_quality_result = 200;

Parameter
Name	Description
`value`	`DataQualityResult`

Returns
Type	Description
`DataScan.Builder`

setDataQualityResult(DataQualityResult.Builder builderForValue)

public DataScan.Builder setDataQualityResult(DataQualityResult.Builder builderForValue)

Output only. The result of the data quality scan.

.google.events.cloud.dataplex.v1.DataQualityResult data_quality_result = 200;

Parameter
Name	Description
`builderForValue`	`DataQualityResult.Builder`

Returns
Type	Description
`DataScan.Builder`

setDataQualitySpec(DataQualitySpec value)

public DataScan.Builder setDataQualitySpec(DataQualitySpec value)

DataQualityScan related setting.

.google.events.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;

Parameter
Name	Description
`value`	`DataQualitySpec`

Returns
Type	Description
`DataScan.Builder`

setDataQualitySpec(DataQualitySpec.Builder builderForValue)

public DataScan.Builder setDataQualitySpec(DataQualitySpec.Builder builderForValue)

DataQualityScan related setting.

.google.events.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;

Parameter
Name	Description
`builderForValue`	`DataQualitySpec.Builder`

Returns
Type	Description
`DataScan.Builder`

setDescription(String value)

public DataScan.Builder setDescription(String value)

Optional. Description of the scan.

Must be between 1-1024 characters.

string description = 3;

Parameter
Name	Description
`value`	`String` The description to set.

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

setDescriptionBytes(ByteString value)

public DataScan.Builder setDescriptionBytes(ByteString value)

Optional. Description of the scan.

Must be between 1-1024 characters.

string description = 3;

Parameter
Name	Description
`value`	`ByteString` The bytes for description to set.

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

setDisplayName(String value)

public DataScan.Builder setDisplayName(String value)

Optional. User friendly display name.

Must be between 1-256 characters.

string display_name = 4;

Parameter
Name	Description
`value`	`String` The displayName to set.

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

setDisplayNameBytes(ByteString value)

public DataScan.Builder setDisplayNameBytes(ByteString value)

Optional. User friendly display name.

Must be between 1-256 characters.

string display_name = 4;

Parameter
Name	Description
`value`	`ByteString` The bytes for displayName to set.

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

setExecutionSpec(DataScan.ExecutionSpec value)

public DataScan.Builder setExecutionSpec(DataScan.ExecutionSpec value)

Optional. DataScan execution settings. If not specified, the fields in it will use their default values.

.google.events.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10;

Parameter
Name	Description
`value`	`DataScan.ExecutionSpec`

Returns
Type	Description
`DataScan.Builder`

setExecutionSpec(DataScan.ExecutionSpec.Builder builderForValue)

public DataScan.Builder setExecutionSpec(DataScan.ExecutionSpec.Builder builderForValue)

Optional. DataScan execution settings. If not specified, the fields in it will use their default values.

.google.events.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10;

Parameter
Name	Description
`builderForValue`	`DataScan.ExecutionSpec.Builder`

Returns
Type	Description
`DataScan.Builder`

setExecutionStatus(DataScan.ExecutionStatus value)

public DataScan.Builder setExecutionStatus(DataScan.ExecutionStatus value)

Output only. Status of the data scan execution.

.google.events.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11;

Parameter
Name	Description
`value`	`DataScan.ExecutionStatus`

Returns
Type	Description
`DataScan.Builder`

setExecutionStatus(DataScan.ExecutionStatus.Builder builderForValue)

public DataScan.Builder setExecutionStatus(DataScan.ExecutionStatus.Builder builderForValue)

Output only. Status of the data scan execution.

.google.events.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11;

Parameter
Name	Description
`builderForValue`	`DataScan.ExecutionStatus.Builder`

Returns
Type	Description
`DataScan.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public DataScan.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DataScan.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public DataScan.Builder setName(String value)

string name = 1;

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public DataScan.Builder setNameBytes(ByteString value)

string name = 1;

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`DataScan.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setState(State value)

public DataScan.Builder setState(State value)

Output only. Current state of the DataScan.

.google.events.cloud.dataplex.v1.State state = 6;

Parameter
Name	Description
`value`	`State` The state to set.

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

setStateValue(int value)

public DataScan.Builder setStateValue(int value)

Output only. Current state of the DataScan.

.google.events.cloud.dataplex.v1.State state = 6;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for state to set.

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

setType(DataScanType value)

public DataScan.Builder setType(DataScanType value)

Output only. The type of DataScan.

.google.events.cloud.dataplex.v1.DataScanType type = 12;

Parameter
Name	Description
`value`	`DataScanType` The type to set.

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

setTypeValue(int value)

public DataScan.Builder setTypeValue(int value)

Output only. The type of DataScan.

.google.events.cloud.dataplex.v1.DataScanType type = 12;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for type to set.

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

setUid(String value)

public DataScan.Builder setUid(String value)

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

string uid = 2;

Parameter
Name	Description
`value`	`String` The uid to set.

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

setUidBytes(ByteString value)

public DataScan.Builder setUidBytes(ByteString value)

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

string uid = 2;

Parameter
Name	Description
`value`	`ByteString` The bytes for uid to set.

Returns
Type	Description
`DataScan.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DataScan.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DataScan.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public DataScan.Builder setUpdateTime(Timestamp value)

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

.google.protobuf.Timestamp update_time = 8;

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`DataScan.Builder`

setUpdateTime(Timestamp.Builder builderForValue)

public DataScan.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp update_time = 8;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`DataScan.Builder`