Class DataScan (1.52.0) 

public final class DataScan extends GeneratedMessageV3 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.cloud.dataplex.v1.DataScan

Inheritance

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

Implements

DataScanOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DATA_DISCOVERY_RESULT_FIELD_NUMBER

public static final int DATA_DISCOVERY_RESULT_FIELD_NUMBER
Field Value
Type Description
int

DATA_DISCOVERY_SPEC_FIELD_NUMBER

public static final int DATA_DISCOVERY_SPEC_FIELD_NUMBER
Field Value
Type Description
int

DATA_FIELD_NUMBER

public static final int DATA_FIELD_NUMBER
Field Value
Type Description
int

DATA_PROFILE_RESULT_FIELD_NUMBER

public static final int DATA_PROFILE_RESULT_FIELD_NUMBER
Field Value
Type Description
int

DATA_PROFILE_SPEC_FIELD_NUMBER

public static final int DATA_PROFILE_SPEC_FIELD_NUMBER
Field Value
Type Description
int

DATA_QUALITY_RESULT_FIELD_NUMBER

public static final int DATA_QUALITY_RESULT_FIELD_NUMBER
Field Value
Type Description
int

DATA_QUALITY_SPEC_FIELD_NUMBER

public static final int DATA_QUALITY_SPEC_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_SPEC_FIELD_NUMBER

public static final int EXECUTION_SPEC_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_STATUS_FIELD_NUMBER

public static final int EXECUTION_STATUS_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DataScan getDefaultInstance()
Returns
Type Description
DataScan

getDescriptor()

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

newBuilder()

public static DataScan.Builder newBuilder()
Returns
Type Description
DataScan.Builder

newBuilder(DataScan prototype)

public static DataScan.Builder newBuilder(DataScan prototype)
Parameter
Name Description
prototype DataScan
Returns
Type Description
DataScan.Builder

parseDelimitedFrom(InputStream input)

public static DataScan parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataScan
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataScan parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataScan
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DataScan parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DataScan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataScan parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataScan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataScan parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DataScan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataScan parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataScan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataScan parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DataScan
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataScan parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataScan
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DataScan parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataScan
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataScan parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataScan
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DataScan parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DataScan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataScan parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataScan
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DataScan> parser()
Returns
Type Description
Parser<DataScan>

Methods

containsLabels(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

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

getDataDiscoveryResult()

public DataDiscoveryResult getDataDiscoveryResult()

Output only. The result of a data discovery scan.

.google.cloud.dataplex.v1.DataDiscoveryResult data_discovery_result = 202 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataDiscoveryResult

The dataDiscoveryResult.

getDataDiscoveryResultOrBuilder()

public DataDiscoveryResultOrBuilder getDataDiscoveryResultOrBuilder()

Output only. The result of a data discovery scan.

.google.cloud.dataplex.v1.DataDiscoveryResult data_discovery_result = 202 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataDiscoveryResultOrBuilder

getDataDiscoverySpec()

public DataDiscoverySpec getDataDiscoverySpec()

Settings for a data discovery scan.

.google.cloud.dataplex.v1.DataDiscoverySpec data_discovery_spec = 102;

Returns
Type Description
DataDiscoverySpec

The dataDiscoverySpec.

getDataDiscoverySpecOrBuilder()

public DataDiscoverySpecOrBuilder getDataDiscoverySpecOrBuilder()

Settings for a data discovery scan.

.google.cloud.dataplex.v1.DataDiscoverySpec data_discovery_spec = 102;

Returns
Type Description
DataDiscoverySpecOrBuilder

getDataOrBuilder()

public 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 DataProfileResult getDataProfileResult()

Output only. The result of a 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 DataProfileResultOrBuilder getDataProfileResultOrBuilder()

Output only. The result of a data profile scan.

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

Returns
Type Description
DataProfileResultOrBuilder

getDataProfileSpec()

public DataProfileSpec getDataProfileSpec()

Settings for a data profile scan.

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

Returns
Type Description
DataProfileSpec

The dataProfileSpec.

getDataProfileSpecOrBuilder()

public DataProfileSpecOrBuilder getDataProfileSpecOrBuilder()

Settings for a data profile scan.

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

Returns
Type Description
DataProfileSpecOrBuilder

getDataQualityResult()

public DataQualityResult getDataQualityResult()

Output only. The result of a 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 DataQualityResultOrBuilder getDataQualityResultOrBuilder()

Output only. The result of a data quality scan.

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

Returns
Type Description
DataQualityResultOrBuilder

getDataQualitySpec()

public DataQualitySpec getDataQualitySpec()

Settings for a data quality scan.

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

Returns
Type Description
DataQualitySpec

The dataQualitySpec.

getDataQualitySpecOrBuilder()

public DataQualitySpecOrBuilder getDataQualitySpecOrBuilder()

Settings for a data quality scan.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public 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 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 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 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 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 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 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() (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 scan.

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

Returns
Type Description
int

getLabelsMap()

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

getParserForType()

public Parser<DataScan> getParserForType()
Returns
Type Description
Parser<DataScan>
Overrides

getResultCase()

public DataScan.ResultCase getResultCase()
Returns
Type Description
DataScan.ResultCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSpecCase()

public DataScan.SpecCase getSpecCase()
Returns
Type Description
DataScan.SpecCase

getState()

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

hasDataDiscoveryResult()

public boolean hasDataDiscoveryResult()

Output only. The result of a data discovery scan.

.google.cloud.dataplex.v1.DataDiscoveryResult data_discovery_result = 202 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the dataDiscoveryResult field is set.

hasDataDiscoverySpec()

public boolean hasDataDiscoverySpec()

Settings for a data discovery scan.

.google.cloud.dataplex.v1.DataDiscoverySpec data_discovery_spec = 102;

Returns
Type Description
boolean

Whether the dataDiscoverySpec field is set.

hasDataProfileResult()

public boolean hasDataProfileResult()

Output only. The result of a 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 boolean hasDataProfileSpec()

Settings for a data profile scan.

.google.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 a 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 boolean hasDataQualitySpec()

Settings for a data quality scan.

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DataScan.Builder newBuilderForType()
Returns
Type Description
DataScan.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DataScan.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DataScan.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DataScan.Builder toBuilder()
Returns
Type Description
DataScan.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException