Google Cloud Dataplex V1 Client - Class DataScanJob (1.1.0)

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

A DataScanJob represents an instance of DataScan execution.

Generated from protobuf message google.cloud.dataplex.v1.DataScanJob

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

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 string

Output only. System generated globally unique ID for the DataScanJob.
↳ create_time Google\Protobuf\Timestamp

Output only. The time when the DataScanJob was created.
↳ start_time Google\Protobuf\Timestamp

Output only. The time when the DataScanJob was started.
↳ end_time Google\Protobuf\Timestamp

Output only. The time when the DataScanJob ended.
↳ state int

Output only. Execution state for the DataScanJob.
↳ message string

Output only. Additional information about the current state.
↳ type int

Output only. The type of the parent DataScan.
↳ data_quality_spec DataQualitySpec

Output only. Settings for a data quality scan.
↳ data_profile_spec DataProfileSpec

Output only. Settings for a data profile scan.
↳ data_discovery_spec DataDiscoverySpec

Output only. Settings for a data discovery scan.
↳ data_quality_result DataQualityResult

Output only. The result of a data quality scan.
↳ data_profile_result DataProfileResult

Output only. The result of a data profile scan.
↳ data_discovery_result DataDiscoveryResult

Output only. The result of a data discovery scan.

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.

Returns
Type Description
string

setName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getUid

Output only. System generated globally unique ID for the DataScanJob.

Returns
Type Description
string

setUid

Output only. System generated globally unique ID for the DataScanJob.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The time when the DataScanJob was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the DataScanJob was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getStartTime

Output only. The time when the DataScanJob was started.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Output only. The time when the DataScanJob was started.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getEndTime

Output only. The time when the DataScanJob ended.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

Output only. The time when the DataScanJob ended.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getState

Output only. Execution state for the DataScanJob.

Returns
Type Description
int

setState

Output only. Execution state for the DataScanJob.

Parameter
Name Description
var int
Returns
Type Description
$this

getMessage

Output only. Additional information about the current state.

Returns
Type Description
string

setMessage

Output only. Additional information about the current state.

Parameter
Name Description
var string
Returns
Type Description
$this

getType

Output only. The type of the parent DataScan.

Returns
Type Description
int

setType

Output only. The type of the parent DataScan.

Parameter
Name Description
var int
Returns
Type Description
$this

getDataQualitySpec

Output only. Settings for a data quality scan.

Returns
Type Description
DataQualitySpec|null

hasDataQualitySpec

setDataQualitySpec

Output only. Settings for a data quality scan.

Parameter
Name Description
var DataQualitySpec
Returns
Type Description
$this

getDataProfileSpec

Output only. Settings for a data profile scan.

Returns
Type Description
DataProfileSpec|null

hasDataProfileSpec

setDataProfileSpec

Output only. Settings for a data profile scan.

Parameter
Name Description
var DataProfileSpec
Returns
Type Description
$this

getDataDiscoverySpec

Output only. Settings for a data discovery scan.

Returns
Type Description
DataDiscoverySpec|null

hasDataDiscoverySpec

setDataDiscoverySpec

Output only. Settings for a data discovery scan.

Parameter
Name Description
var DataDiscoverySpec
Returns
Type Description
$this

getDataQualityResult

Output only. The result of a data quality scan.

Returns
Type Description
DataQualityResult|null

hasDataQualityResult

setDataQualityResult

Output only. The result of a data quality scan.

Parameter
Name Description
var DataQualityResult
Returns
Type Description
$this

getDataProfileResult

Output only. The result of a data profile scan.

Returns
Type Description
DataProfileResult|null

hasDataProfileResult

setDataProfileResult

Output only. The result of a data profile scan.

Parameter
Name Description
var DataProfileResult
Returns
Type Description
$this

getDataDiscoveryResult

Output only. The result of a data discovery scan.

Returns
Type Description
DataDiscoveryResult|null

hasDataDiscoveryResult

setDataDiscoveryResult

Output only. The result of a data discovery scan.

Parameter
Name Description
var DataDiscoveryResult
Returns
Type Description
$this

getSpec

Returns
Type Description
string

getResult

Returns
Type Description
string