Dataplex V1 API - Class Google::Cloud::Dataplex::V1::DataScanJob (v1.4.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::DataScanJob.

A DataScanJob represents an instance of DataScan execution.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#data_discovery_result

def data_discovery_result() -> ::Google::Cloud::Dataplex::V1::DataDiscoveryResult
Returns
  • (::Google::Cloud::Dataplex::V1::DataDiscoveryResult) — Output only. The result of a data discovery scan.

    Note: The following fields are mutually exclusive: data_discovery_result, data_quality_result, data_profile_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_discovery_spec

def data_discovery_spec() -> ::Google::Cloud::Dataplex::V1::DataDiscoverySpec
Returns
  • (::Google::Cloud::Dataplex::V1::DataDiscoverySpec) — Output only. Settings for a data discovery scan.

    Note: The following fields are mutually exclusive: data_discovery_spec, data_quality_spec, data_profile_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_profile_result

def data_profile_result() -> ::Google::Cloud::Dataplex::V1::DataProfileResult
Returns
  • (::Google::Cloud::Dataplex::V1::DataProfileResult) — Output only. The result of a data profile scan.

    Note: The following fields are mutually exclusive: data_profile_result, data_quality_result, data_discovery_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_profile_spec

def data_profile_spec() -> ::Google::Cloud::Dataplex::V1::DataProfileSpec
Returns
  • (::Google::Cloud::Dataplex::V1::DataProfileSpec) — Output only. Settings for a data profile scan.

    Note: The following fields are mutually exclusive: data_profile_spec, data_quality_spec, data_discovery_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_quality_result

def data_quality_result() -> ::Google::Cloud::Dataplex::V1::DataQualityResult
Returns
  • (::Google::Cloud::Dataplex::V1::DataQualityResult) — Output only. The result of a data quality scan.

    Note: The following fields are mutually exclusive: data_quality_result, data_profile_result, data_discovery_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_quality_spec

def data_quality_spec() -> ::Google::Cloud::Dataplex::V1::DataQualitySpec
Returns
  • (::Google::Cloud::Dataplex::V1::DataQualitySpec) — Output only. Settings for a data quality scan.

    Note: The following fields are mutually exclusive: data_quality_spec, data_profile_spec, data_discovery_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#end_time

def end_time() -> ::Google::Protobuf::Timestamp
Returns

#message

def message() -> ::String
Returns
  • (::String) — Output only. Additional information about the current state.

#name

def name() -> ::String
Returns
  • (::String) — Output only. Identifier. 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.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp
Returns

#state

def state() -> ::Google::Cloud::Dataplex::V1::DataScanJob::State
Returns

#type

def type() -> ::Google::Cloud::Dataplex::V1::DataScanType
Returns

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. System generated globally unique ID for the DataScanJob.