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
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: |
↳ uid |
string
Output only. System generated globally unique ID for the DataScanJob. |
↳ 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 |
Google\Cloud\Dataplex\V1\DataQualitySpec
Output only. DataQualityScan related setting. |
↳ data_profile_spec |
Google\Cloud\Dataplex\V1\DataProfileSpec
Output only. DataProfileScan related setting. |
↳ data_quality_result |
Google\Cloud\Dataplex\V1\DataQualityResult
Output only. The result of the data quality scan. |
↳ data_profile_result |
Google\Cloud\Dataplex\V1\DataProfileResult
Output only. The result of the data profile 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 | |
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. DataQualityScan related setting.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\DataQualitySpec|null | |
hasDataQualitySpec
setDataQualitySpec
Output only. DataQualityScan related setting.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\DataQualitySpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDataProfileSpec
Output only. DataProfileScan related setting.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\DataProfileSpec|null | |
hasDataProfileSpec
setDataProfileSpec
Output only. DataProfileScan related setting.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\DataProfileSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDataQualityResult
Output only. The result of the data quality scan.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\DataQualityResult|null | |
hasDataQualityResult
setDataQualityResult
Output only. The result of the data quality scan.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\DataQualityResult
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDataProfileResult
Output only. The result of the data profile scan.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\DataProfileResult|null | |
hasDataProfileResult
setDataProfileResult
Output only. The result of the data profile scan.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\DataProfileResult
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSpec
| Returns | |
|---|---|
| Type | Description |
string | |
getResult
| Returns | |
|---|---|
| Type | Description |
string | |