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 messagegoogle.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. Identifier. The relative resource name of the DataScanJob, of the form:projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, whereprojectrefers to aproject_idorproject_numberandlocation_idrefers to a GCP region.
↳ uid
string
Output only. System generated globally unique ID for the DataScanJob.
Output only. Identifier. The relative resource name of the DataScanJob, of
the form:projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id},
whereprojectrefers to aproject_idorproject_numberandlocation_idrefers to a GCP region.
Returns
Type
Description
string
setName
Output only. Identifier. The relative resource name of the DataScanJob, of
the form:projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id},
whereprojectrefers to aproject_idorproject_numberandlocation_idrefers 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataplex V1 Client - Class DataScanJob (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.DataScanJob)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.DataScanJob)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.DataScanJob)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.DataScanJob)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.DataScanJob)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.DataScanJob)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.DataScanJob)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.DataScanJob)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.DataScanJob)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.DataScanJob)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.DataScanJob)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.DataScanJob)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.DataScanJob)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.DataScanJob)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.DataScanJob)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.DataScanJob)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.DataScanJob)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.DataScanJob)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.DataScanJob)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.DataScanJob)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.DataScanJob)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.DataScanJob)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.DataScanJob)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.DataScanJob) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class DataScanJob.\n\nA DataScanJob represents an instance of DataScan execution.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.DataScanJob`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. Identifier. The relative resource name of the DataScanJob, of\nthe form:\n`projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}`,\nwhere `project` refers to a *project_id* or *project_number* and\n`location_id` refers to a GCP region.\n\n### setName\n\nOutput only. Identifier. The relative resource name of the DataScanJob, of\nthe form:\n`projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}`,\nwhere `project` refers to a *project_id* or *project_number* and\n`location_id` refers to a GCP region.\n\n### getUid\n\nOutput only. System generated globally unique ID for the DataScanJob.\n\n### setUid\n\nOutput only. System generated globally unique ID for the DataScanJob.\n\n### getCreateTime\n\nOutput only. The time when the DataScanJob was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. The time when the DataScanJob was created.\n\n### getStartTime\n\nOutput only. The time when the DataScanJob was started.\n\n### hasStartTime\n\n### clearStartTime\n\n### setStartTime\n\nOutput only. The time when the DataScanJob was started.\n\n### getEndTime\n\nOutput only. The time when the DataScanJob ended.\n\n### hasEndTime\n\n### clearEndTime\n\n### setEndTime\n\nOutput only. The time when the DataScanJob ended.\n\n### getState\n\nOutput only. Execution state for the DataScanJob.\n\n### setState\n\nOutput only. Execution state for the DataScanJob.\n\n### getMessage\n\nOutput only. Additional information about the current state.\n\n### setMessage\n\nOutput only. Additional information about the current state.\n\n### getType\n\nOutput only. The type of the parent DataScan.\n\n### setType\n\nOutput only. The type of the parent DataScan.\n\n### getDataQualitySpec\n\nOutput only. Settings for a data quality scan.\n\n### hasDataQualitySpec\n\n### setDataQualitySpec\n\nOutput only. Settings for a data quality scan.\n\n### getDataProfileSpec\n\nOutput only. Settings for a data profile scan.\n\n### hasDataProfileSpec\n\n### setDataProfileSpec\n\nOutput only. Settings for a data profile scan.\n\n### getDataDiscoverySpec\n\nOutput only. Settings for a data discovery scan.\n\n### hasDataDiscoverySpec\n\n### setDataDiscoverySpec\n\nOutput only. Settings for a data discovery scan.\n\n### getDataQualityResult\n\nOutput only. The result of a data quality scan.\n\n### hasDataQualityResult\n\n### setDataQualityResult\n\nOutput only. The result of a data quality scan.\n\n### getDataProfileResult\n\nOutput only. The result of a data profile scan.\n\n### hasDataProfileResult\n\n### setDataProfileResult\n\nOutput only. The result of a data profile scan.\n\n### getDataDiscoveryResult\n\nOutput only. The result of a data discovery scan.\n\n### hasDataDiscoveryResult\n\n### setDataDiscoveryResult\n\nOutput only. The result of a data discovery scan.\n\n### getSpec\n\n### getResult"]]
