Interface DataScanOrBuilder (1.25.0)

Version 1.25.0

• 1.51.0 (latest)
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.2
• 1.0.1
• 0.2.2

public interface DataScanOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. User-defined labels for the scan.

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

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time when the scan was created.

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

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the scan was created.

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

Returns
Type	Description
TimestampOrBuilder

getData()

public abstract DataSource getData()

Required. The data source for DataScan.

.google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
DataSource	The data.

getDataOrBuilder()

public abstract DataSourceOrBuilder getDataOrBuilder()

Required. The data source for DataScan.

.google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
DataSourceOrBuilder

getDataProfileResult()

public abstract DataProfileResult getDataProfileResult()

Output only. The result of the data profile scan.

.google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DataProfileResult	The dataProfileResult.

getDataProfileResultOrBuilder()

public abstract DataProfileResultOrBuilder getDataProfileResultOrBuilder()

Output only. The result of the data profile scan.

.google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DataProfileResultOrBuilder

getDataProfileSpec()

public abstract DataProfileSpec getDataProfileSpec()

DataProfileScan related setting.

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

Returns
Type	Description
DataProfileSpec	The dataProfileSpec.

getDataProfileSpecOrBuilder()

public abstract DataProfileSpecOrBuilder getDataProfileSpecOrBuilder()

DataProfileScan related setting.

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

Returns
Type	Description
DataProfileSpecOrBuilder

getDataQualityResult()

public abstract DataQualityResult getDataQualityResult()

Output only. The result of the data quality scan.

.google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DataQualityResult	The dataQualityResult.

getDataQualityResultOrBuilder()

public abstract DataQualityResultOrBuilder getDataQualityResultOrBuilder()

Output only. The result of the data quality scan.

.google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DataQualityResultOrBuilder

getDataQualitySpec()

public abstract DataQualitySpec getDataQualitySpec()

DataQualityScan related setting.

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

Returns
Type	Description
DataQualitySpec	The dataQualitySpec.

getDataQualitySpecOrBuilder()

public abstract DataQualitySpecOrBuilder getDataQualitySpecOrBuilder()

DataQualityScan related setting.

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

Returns
Type	Description
DataQualitySpecOrBuilder

getDescription()

public abstract String getDescription()

Optional. Description of the scan.

• Must be between 1-1024 characters.

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

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. Description of the scan.

• Must be between 1-1024 characters.

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

Returns
Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Optional. User friendly display name.

• Must be between 1-256 characters.

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

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Optional. User friendly display name.

• Must be between 1-256 characters.

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

Returns
Type	Description
ByteString	The bytes for displayName.

getExecutionSpec()

public abstract DataScan.ExecutionSpec getExecutionSpec()

Optional. DataScan execution settings.

If not specified, the fields in it will use their default values.

.google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataScan.ExecutionSpec	The executionSpec.

getExecutionSpecOrBuilder()

public abstract DataScan.ExecutionSpecOrBuilder getExecutionSpecOrBuilder()

Optional. DataScan execution settings.

If not specified, the fields in it will use their default values.

.google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataScan.ExecutionSpecOrBuilder

getExecutionStatus()

public abstract DataScan.ExecutionStatus getExecutionStatus()

Output only. Status of the data scan execution.

.google.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DataScan.ExecutionStatus	The executionStatus.

getExecutionStatusOrBuilder()

public abstract DataScan.ExecutionStatusOrBuilder getExecutionStatusOrBuilder()

Output only. Status of the data scan execution.

.google.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DataScan.ExecutionStatusOrBuilder

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. User-defined labels for the scan.

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

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. User-defined labels for the scan.

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

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. User-defined labels for the scan.

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

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. User-defined labels for the scan.

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

Parameter
Name	Description
key	String

Returns
Type	Description
String

getName()

public abstract String getName()

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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for name.

getResultCase()

public abstract DataScan.ResultCase getResultCase()

Returns
Type	Description
DataScan.ResultCase

getSpecCase()

public abstract DataScan.SpecCase getSpecCase()

Returns
Type	Description
DataScan.SpecCase

getState()

public abstract State getState()

Output only. Current state of the DataScan.

.google.cloud.dataplex.v1.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
State	The state.

getStateValue()

public abstract int getStateValue()

Output only. Current state of the DataScan.

.google.cloud.dataplex.v1.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getType()

public abstract DataScanType getType()

Output only. The type of DataScan.

.google.cloud.dataplex.v1.DataScanType type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DataScanType	The type.

getTypeValue()

public abstract int getTypeValue()

Output only. The type of DataScan.

.google.cloud.dataplex.v1.DataScanType type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getUid()

public abstract 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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The uid.

getUidBytes()

public abstract 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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for uid.

getUpdateTime()

public abstract Timestamp getUpdateTime()

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

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

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time when the scan was created.

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

Returns
Type	Description
boolean	Whether the createTime field is set.

hasData()

public abstract boolean hasData()

Required. The data source for DataScan.

.google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the data field is set.

hasDataProfileResult()

public abstract boolean hasDataProfileResult()

Output only. The result of the data profile scan.

.google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the dataProfileResult field is set.

hasDataProfileSpec()

public abstract boolean hasDataProfileSpec()

DataProfileScan related setting.

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

Returns
Type	Description
boolean	Whether the dataProfileSpec field is set.

hasDataQualityResult()

public abstract boolean hasDataQualityResult()

Output only. The result of the data quality scan.

.google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the dataQualityResult field is set.

hasDataQualitySpec()

public abstract boolean hasDataQualitySpec()

DataQualityScan related setting.

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

Returns
Type	Description
boolean	Whether the dataQualitySpec field is set.

hasExecutionSpec()

public abstract boolean hasExecutionSpec()

Optional. DataScan execution settings.

If not specified, the fields in it will use their default values.

.google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the executionSpec field is set.

hasExecutionStatus()

public abstract boolean hasExecutionStatus()

Output only. Status of the data scan execution.

.google.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the executionStatus field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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

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

Returns
Type	Description
boolean	Whether the updateTime field is set.