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
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DATA_FIELD_NUMBER
public static final int DATA_FIELD_NUMBER
Field Value
DATA_PROFILE_RESULT_FIELD_NUMBER
public static final int DATA_PROFILE_RESULT_FIELD_NUMBER
Field Value
DATA_PROFILE_SPEC_FIELD_NUMBER
public static final int DATA_PROFILE_SPEC_FIELD_NUMBER
Field Value
DATA_QUALITY_RESULT_FIELD_NUMBER
public static final int DATA_QUALITY_RESULT_FIELD_NUMBER
Field Value
DATA_QUALITY_SPEC_FIELD_NUMBER
public static final int DATA_QUALITY_SPEC_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
EXECUTION_SPEC_FIELD_NUMBER
public static final int EXECUTION_SPEC_FIELD_NUMBER
Field Value
EXECUTION_STATUS_FIELD_NUMBER
public static final int EXECUTION_STATUS_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static DataScan getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static DataScan.Builder newBuilder()
Returns
newBuilder(DataScan prototype)
public static DataScan.Builder newBuilder(DataScan prototype)
Parameter
Returns
public static DataScan parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DataScan parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DataScan parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DataScan parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DataScan parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataScan parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DataScan parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DataScan parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DataScan parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DataScan parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DataScan parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DataScan parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<DataScan> parser()
Returns
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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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];
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];
getData()
public DataSource getData()
Required. The data source for DataScan.
.google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];
getDataOrBuilder()
public DataSourceOrBuilder getDataOrBuilder()
Required. The data source for DataScan.
.google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];
getDataProfileResult()
public 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];
getDataProfileResultOrBuilder()
public 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];
getDataProfileSpec()
public DataProfileSpec getDataProfileSpec()
DataProfileScan related setting.
.google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
getDataProfileSpecOrBuilder()
public DataProfileSpecOrBuilder getDataProfileSpecOrBuilder()
DataProfileScan related setting.
.google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
getDataQualityResult()
public 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];
getDataQualityResultOrBuilder()
public 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];
getDataQualitySpec()
public DataQualitySpec getDataQualitySpec()
DataQualityScan related setting.
.google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
getDataQualitySpecOrBuilder()
public DataQualitySpecOrBuilder getDataQualitySpecOrBuilder()
DataQualityScan related setting.
.google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
getDefaultInstanceForType()
public DataScan getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
Optional. Description of the scan.
- Must be between 1-1024 characters.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| 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];
| 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];
| 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];
| Type | Description |
| ByteString | The bytes for displayName.
|
getExecutionSpec()
public DataScan.ExecutionSpec getExecutionSpec()
Optional. DataScan execution settings.
If not specified, the fields under it will use their default values.
.google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
getExecutionSpecOrBuilder()
public DataScan.ExecutionSpecOrBuilder getExecutionSpecOrBuilder()
Optional. DataScan execution settings.
If not specified, the fields under it will use their default values.
.google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
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];
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];
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
Optional. User-defined labels for the scan.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. User-defined labels for the scan.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
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];
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];
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];
| 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];
getParserForType()
public Parser<DataScan> getParserForType()
Returns
Overrides
getResultCase()
public DataScan.ResultCase getResultCase()
Returns
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSpecCase()
public DataScan.SpecCase getSpecCase()
Returns
getState()
Output only. Current state of the DataScan.
.google.cloud.dataplex.v1.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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];
| 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];
getTypeValue()
public int getTypeValue()
Output only. The type of DataScan.
.google.cloud.dataplex.v1.DataScanType type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The enum numeric value on the wire for type.
|
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];
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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
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];
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];
| Type | Description |
| boolean | Whether the createTime field is set.
|
hasData()
Required. The data source for DataScan.
.google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the data field is set.
|
hasDataProfileResult()
public 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];
| Type | Description |
| boolean | Whether the dataProfileResult field is set.
|
hasDataProfileSpec()
public boolean hasDataProfileSpec()
DataProfileScan related setting.
.google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
| Type | Description |
| boolean | Whether the dataProfileSpec field is set.
|
hasDataQualityResult()
public 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];
| Type | Description |
| boolean | Whether the dataQualityResult field is set.
|
hasDataQualitySpec()
public boolean hasDataQualitySpec()
DataQualityScan related setting.
.google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
| Type | Description |
| boolean | Whether the dataQualitySpec field is set.
|
hasExecutionSpec()
public boolean hasExecutionSpec()
Optional. DataScan execution settings.
If not specified, the fields under it will use their default values.
.google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
| 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];
| 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];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public DataScan.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DataScan.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public DataScan.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
