Class DataScanJob (1.13.0)

DataScanJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A DataScanJob represents an instance of DataScan execution.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
name str
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.
uid str
Output only. System generated globally unique ID for the DataScanJob.
start_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time when the DataScanJob was started.
end_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time when the DataScanJob ended.
state google.cloud.dataplex_v1.types.DataScanJob.State
Output only. Execution state for the DataScanJob.
message str
Output only. Additional information about the current state.
type_ google.cloud.dataplex_v1.types.DataScanType
Output only. The type of the parent DataScan.
data_quality_spec google.cloud.dataplex_v1.types.DataQualitySpec
Output only. DataQualityScan related setting. This field is a member of oneof_ spec.
data_profile_spec google.cloud.dataplex_v1.types.DataProfileSpec
Output only. DataProfileScan related setting. This field is a member of oneof_ spec.
data_quality_result google.cloud.dataplex_v1.types.DataQualityResult
Output only. The result of the data quality scan. This field is a member of oneof_ result.
data_profile_result google.cloud.dataplex_v1.types.DataProfileResult
Output only. The result of the data profile scan. This field is a member of oneof_ result.

Classes

State

State(value)

Execution state for the DataScanJob.

Values: STATE_UNSPECIFIED (0): The DataScanJob state is unspecified. RUNNING (1): The DataScanJob is running. CANCELING (2): The DataScanJob is canceling. CANCELLED (3): The DataScanJob cancellation was successful. SUCCEEDED (4): The DataScanJob completed successfully. FAILED (5): The DataScanJob is no longer running due to an error. PENDING (7): The DataScanJob has been created but not started to run yet.