Class DataScanJob (1.46.0)

public final class DataScanJob extends GeneratedMessageV3 implements DataScanJobOrBuilder

A DataScanJob represents an instance of DataScan execution.

Protobuf type google.cloud.dataplex.v1.DataScanJob

Static Fields

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

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_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

Static Methods

getDefaultInstance()

public static DataScanJob getDefaultInstance()
Returns
Type Description
DataScanJob

getDescriptor()

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

newBuilder()

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

newBuilder(DataScanJob prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

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];

Returns
Type Description
DataProfileResult

The dataProfileResult.

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];

Returns
Type Description
DataProfileResultOrBuilder

getDataProfileSpec()

public DataProfileSpec getDataProfileSpec()

Output only. DataProfileScan related setting.

.google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataProfileSpec

The dataProfileSpec.

getDataProfileSpecOrBuilder()

public DataProfileSpecOrBuilder getDataProfileSpecOrBuilder()

Output only. DataProfileScan related setting.

.google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataProfileSpecOrBuilder

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];

Returns
Type Description
DataQualityResult

The dataQualityResult.

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];

Returns
Type Description
DataQualityResultOrBuilder

getDataQualitySpec()

public DataQualitySpec getDataQualitySpec()

Output only. DataQualityScan related setting.

.google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualitySpec

The dataQualitySpec.

getDataQualitySpecOrBuilder()

public DataQualitySpecOrBuilder getDataQualitySpecOrBuilder()

Output only. DataQualityScan related setting.

.google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualitySpecOrBuilder

getDefaultInstanceForType()

public DataScanJob getDefaultInstanceForType()
Returns
Type Description
DataScanJob

getEndTime()

public Timestamp getEndTime()

Output only. The time when the DataScanJob ended.

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

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. The time when the DataScanJob ended.

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

Returns
Type Description
TimestampOrBuilder

getMessage()

public String getMessage()

Output only. Additional information about the current state.

string message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The message.

getMessageBytes()

public ByteString getMessageBytes()

Output only. Additional information about the current state.

string message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for message.

getName()

public String getName()

Output only. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_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 DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_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<DataScanJob> getParserForType()
Returns
Type Description
Parser<DataScanJob>
Overrides

getResultCase()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSpecCase()

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

getStartTime()

public Timestamp getStartTime()

Output only. The time when the DataScanJob was started.

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

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. The time when the DataScanJob was started.

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

Returns
Type Description
TimestampOrBuilder

getState()

public DataScanJob.State getState()

Output only. Execution state for the DataScanJob.

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

Returns
Type Description
DataScanJob.State

The state.

getStateValue()

public int getStateValue()

Output only. Execution state for the DataScanJob.

.google.cloud.dataplex.v1.DataScanJob.State state = 5 [(.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 the parent DataScan.

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

Returns
Type Description
DataScanType

The type.

getTypeValue()

public int getTypeValue()

Output only. The type of the parent DataScan.

.google.cloud.dataplex.v1.DataScanType type = 7 [(.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 DataScanJob.

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

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

Returns
Type Description
ByteString

The bytes for uid.

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];

Returns
Type Description
boolean

Whether the dataProfileResult field is set.

hasDataProfileSpec()

public boolean hasDataProfileSpec()

Output only. DataProfileScan related setting.

.google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
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];

Returns
Type Description
boolean

Whether the dataQualityResult field is set.

hasDataQualitySpec()

public boolean hasDataQualitySpec()

Output only. DataQualityScan related setting.

.google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the dataQualitySpec field is set.

hasEndTime()

public boolean hasEndTime()

Output only. The time when the DataScanJob ended.

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

Returns
Type Description
boolean

Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

Output only. The time when the DataScanJob was started.

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

Returns
Type Description
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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