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, see Auto 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, see About data profiling.
- Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data.
Generated from protobuf message google.cloud.dataplex.v1.DataScan
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__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: |
↳ 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 |
array|Google\Protobuf\Internal\MapField
Optional. User-defined labels for the scan. |
↳ state |
int
Output only. Current state of the DataScan. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time when the scan was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time when the scan was last updated. |
↳ data |
DataSource
Required. The data source for DataScan. |
↳ execution_spec |
DataScan\ExecutionSpec
Optional. DataScan execution settings. If not specified, the fields in it will use their default values. |
↳ execution_status |
DataScan\ExecutionStatus
Output only. Status of the data scan execution. |
↳ type |
int
Output only. The type of DataScan. |
↳ data_quality_spec |
DataQualitySpec
Settings for a data quality scan. |
↳ data_profile_spec |
DataProfileSpec
Settings for a data profile scan. |
↳ data_discovery_spec |
DataDiscoverySpec
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. Identifier. 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 Google Cloud 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},
where project refers to a project_id or project_number and
location_id refers to a Google Cloud 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description of the scan.
- Must be between 1-1024 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Description of the scan.
- Must be between 1-1024 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. User friendly display name.
- Must be between 1-256 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. User friendly display name.
- Must be between 1-256 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. User-defined labels for the scan.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. User-defined labels for the scan.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. Current state of the DataScan.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
Output only. Current state of the DataScan.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time when the scan was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the scan was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The time when the scan was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the scan was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getData
Required. The data source for DataScan.
| Returns | |
|---|---|
| Type | Description |
DataSource|null |
|
hasData
clearData
setData
Required. The data source for DataScan.
| Parameter | |
|---|---|
| Name | Description |
var |
DataSource
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExecutionSpec
Optional. DataScan execution settings.
If not specified, the fields in it will use their default values.
| Returns | |
|---|---|
| Type | Description |
DataScan\ExecutionSpec|null |
|
hasExecutionSpec
clearExecutionSpec
setExecutionSpec
Optional. DataScan execution settings.
If not specified, the fields in it will use their default values.
| Parameter | |
|---|---|
| Name | Description |
var |
DataScan\ExecutionSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExecutionStatus
Output only. Status of the data scan execution.
| Returns | |
|---|---|
| Type | Description |
DataScan\ExecutionStatus|null |
|
hasExecutionStatus
clearExecutionStatus
setExecutionStatus
Output only. Status of the data scan execution.
| Parameter | |
|---|---|
| Name | Description |
var |
DataScan\ExecutionStatus
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
Output only. The type of DataScan.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type DataScanType. |
setType
Output only. The type of DataScan.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type DataScanType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataQualitySpec
Settings for a data quality scan.
| Returns | |
|---|---|
| Type | Description |
DataQualitySpec|null |
|
hasDataQualitySpec
setDataQualitySpec
Settings for a data quality scan.
| Parameter | |
|---|---|
| Name | Description |
var |
DataQualitySpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataProfileSpec
Settings for a data profile scan.
| Returns | |
|---|---|
| Type | Description |
DataProfileSpec|null |
|
hasDataProfileSpec
setDataProfileSpec
Settings for a data profile scan.
| Parameter | |
|---|---|
| Name | Description |
var |
DataProfileSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataDiscoverySpec
Settings for a data discovery scan.
| Returns | |
|---|---|
| Type | Description |
DataDiscoverySpec|null |
|
hasDataDiscoverySpec
setDataDiscoverySpec
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 |
|