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.
- Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc).
Generated from protobuf message google.cloud.dataplex.v1.DataScan
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_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 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.
↳ labels
↳ state
int
Output only. Current state of the DataScan.
↳ create_time
↳ update_time
↳ data
↳ execution_spec
Google\Cloud\Dataplex\V1\DataScan\ExecutionSpec
Optional. DataScan execution settings. If not specified, the fields in it will use their default values.
↳ execution_status
↳ type
int
Output only. The type of DataScan.
↳ data_quality_spec
↳ data_profile_spec
↳ data_quality_result
↳ data_profile_result
getName
Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}
,
where project
refers to a project_id
or project_number
and location_id
refers to a GCP region.
string
setName
Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}
,
where project
refers to a project_id
or project_number
and location_id
refers to a GCP region.
var
string
$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.
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.
var
string
$this
getDescription
Optional. Description of the scan.
- Must be between 1-1024 characters.
string
setDescription
Optional. Description of the scan.
- Must be between 1-1024 characters.
var
string
$this
getDisplayName
Optional. User friendly display name.
- Must be between 1-256 characters.
string
setDisplayName
Optional. User friendly display name.
- Must be between 1-256 characters.
var
string
$this
getLabels
Optional. User-defined labels for the scan.
setLabels
Optional. User-defined labels for the scan.
$this
getState
Output only. Current state of the DataScan.
int
setState
Output only. Current state of the DataScan.
var
int
$this
getCreateTime
Output only. The time when the scan was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the scan was created.
$this
getUpdateTime
Output only. The time when the scan was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the scan was last updated.
$this
getData
Required. The data source for DataScan.
hasData
clearData
setData
Required. The data source for DataScan.
$this
getExecutionSpec
Optional. DataScan execution settings.
If not specified, the fields in it will use their default values.
hasExecutionSpec
clearExecutionSpec
setExecutionSpec
Optional. DataScan execution settings.
If not specified, the fields in it will use their default values.
$this
getExecutionStatus
Output only. Status of the data scan execution.
hasExecutionStatus
clearExecutionStatus
setExecutionStatus
Output only. Status of the data scan execution.
$this
getType
Output only. The type of DataScan.
int
setType
Output only. The type of DataScan.
var
int
$this
getDataQualitySpec
DataQualityScan related setting.
hasDataQualitySpec
setDataQualitySpec
DataQualityScan related setting.
$this
getDataProfileSpec
DataProfileScan related setting.
hasDataProfileSpec
setDataProfileSpec
DataProfileScan related setting.
$this
getDataQualityResult
Output only. The result of the data quality scan.
hasDataQualityResult
setDataQualityResult
Output only. The result of the data quality scan.
$this
getDataProfileResult
Output only. The result of the data profile scan.
hasDataProfileResult
setDataProfileResult
Output only. The result of the data profile scan.
$this
getSpec
string
getResult
string
