Reference documentation and code samples for the Google Cloud Dataplex V1 Client class DataScan.
Represents a user-visible job which provides the insights for the related
data source.
For example:
Data quality: generates queries based on the rules and runs against the
data to get data quality check results. For more information, seeAuto
data quality
overview.
Data profile: analyzes the data in tables and generates insights about
the structure, content and relationships (such as null percent,
cardinality, min/max/mean, etc). For more information, seeAbout data
profiling.
Generated from protobuf messagegoogle.cloud.dataplex.v1.DataScan
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 scan, of the form:projects/{project}/locations/{location_id}/dataScans/{datascan_id}, whereprojectrefers to aproject_idorproject_numberandlocation_idrefers to a GCP region.
↳ uid
string
Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.
↳ description
string
Optional. Description of the scan. * * Must be between 1-1024 characters.
↳ display_name
string
Optional. User friendly display name. * * Must be between 1-256 characters.
Output only. Identifier. The relative resource name of the scan, of the
form:projects/{project}/locations/{location_id}/dataScans/{datascan_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 scan, of the
form:projects/{project}/locations/{location_id}/dataScans/{datascan_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 scan. This ID will
be different if the scan is deleted and re-created with the same name.
Returns
Type
Description
string
setUid
Output only. System generated globally unique ID for the scan. This ID will
be different if the scan is deleted and re-created with the same name.
[[["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 DataScan (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.DataScan)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.DataScan)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.DataScan)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.DataScan)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.DataScan)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.DataScan)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.DataScan)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.DataScan)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.DataScan)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.DataScan)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.DataScan)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.DataScan)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.DataScan)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.DataScan)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.DataScan)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.DataScan)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.DataScan)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.DataScan)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.DataScan)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.DataScan)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.DataScan)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.DataScan)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.DataScan)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.DataScan) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class DataScan.\n\nRepresents a user-visible job which provides the insights for the related\ndata source.\n\nFor example:\n\n- Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see [Auto\n data quality\n overview](https://cloud.google.com/dataplex/docs/auto-data-quality-overview).\n- Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see [About data\n profiling](https://cloud.google.com/dataplex/docs/data-profiling-overview).\n- Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see [Discover and catalog Cloud\n Storage data](https://cloud.google.com/bigquery/docs/automatic-discovery).\n\nGenerated from protobuf message `google.cloud.dataplex.v1.DataScan`\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 scan, of the\nform: `projects/{project}/locations/{location_id}/dataScans/{datascan_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 scan, of the\nform: `projects/{project}/locations/{location_id}/dataScans/{datascan_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 scan. This ID will\nbe different if the scan is deleted and re-created with the same name.\n\n### setUid\n\nOutput only. System generated globally unique ID for the scan. This ID will\nbe different if the scan is deleted and re-created with the same name.\n\n### getDescription\n\nOptional. Description of the scan.\n\n- Must be between 1-1024 characters.\n\n### setDescription\n\nOptional. Description of the scan.\n\n- Must be between 1-1024 characters.\n\n### getDisplayName\n\nOptional. User friendly display name.\n\n- Must be between 1-256 characters.\n\n### setDisplayName\n\nOptional. User friendly display name.\n\n- Must be between 1-256 characters.\n\n### getLabels\n\nOptional. User-defined labels for the scan.\n\n### setLabels\n\nOptional. User-defined labels for the scan.\n\n### getState\n\nOutput only. Current state of the DataScan.\n\n### setState\n\nOutput only. Current state of the DataScan.\n\n### getCreateTime\n\nOutput only. The time when the scan was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. The time when the scan was created.\n\n### getUpdateTime\n\nOutput only. The time when the scan was last updated.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. The time when the scan was last updated.\n\n### getData\n\nRequired. The data source for DataScan.\n\n### hasData\n\n### clearData\n\n### setData\n\nRequired. The data source for DataScan.\n\n### getExecutionSpec\n\nOptional. DataScan execution settings.\n\nIf not specified, the fields in it will use their default values.\n\n### hasExecutionSpec\n\n### clearExecutionSpec\n\n### setExecutionSpec\n\nOptional. DataScan execution settings.\n\nIf not specified, the fields in it will use their default values.\n\n### getExecutionStatus\n\nOutput only. Status of the data scan execution.\n\n### hasExecutionStatus\n\n### clearExecutionStatus\n\n### setExecutionStatus\n\nOutput only. Status of the data scan execution.\n\n### getType\n\nOutput only. The type of DataScan.\n\n### setType\n\nOutput only. The type of DataScan.\n\n### getDataQualitySpec\n\nSettings for a data quality scan.\n\n### hasDataQualitySpec\n\n### setDataQualitySpec\n\nSettings for a data quality scan.\n\n### getDataProfileSpec\n\nSettings for a data profile scan.\n\n### hasDataProfileSpec\n\n### setDataProfileSpec\n\nSettings for a data profile scan.\n\n### getDataDiscoverySpec\n\nSettings for a data discovery scan.\n\n### hasDataDiscoverySpec\n\n### setDataDiscoverySpec\n\nSettings 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"]]
