Google Cloud Dataplex V1 Client - Class DataScan (0.16.1)

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

Namespace

Google \ Cloud \ Dataplex \ V1

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 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 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 Google\Cloud\Dataplex\V1\DataSource

Required. The data source for DataScan.
↳ 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 Google\Cloud\Dataplex\V1\DataScan\ExecutionStatus

Output only. Status of the data scan execution.
↳ type int

Output only. The type of DataScan.
↳ data_quality_spec Google\Cloud\Dataplex\V1\DataQualitySpec

DataQualityScan related setting.
↳ data_profile_spec Google\Cloud\Dataplex\V1\DataProfileSpec

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 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.

Returns
Type Description
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.

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

setState

Output only. Current state of the DataScan.

Parameter
Name Description
var int
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
Google\Cloud\Dataplex\V1\DataSource|null

hasData

clearData

setData

Required. The data source for DataScan.

Parameter
Name Description
var Google\Cloud\Dataplex\V1\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
Google\Cloud\Dataplex\V1\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 Google\Cloud\Dataplex\V1\DataScan\ExecutionSpec
Returns
Type Description
$this

getExecutionStatus

Output only. Status of the data scan execution.

Returns
Type Description
Google\Cloud\Dataplex\V1\DataScan\ExecutionStatus|null

hasExecutionStatus

clearExecutionStatus

setExecutionStatus

Output only. Status of the data scan execution.

Parameter
Name Description
var Google\Cloud\Dataplex\V1\DataScan\ExecutionStatus
Returns
Type Description
$this

getType

Output only. The type of DataScan.

Returns
Type Description
int

setType

Output only. The type of DataScan.

Parameter
Name Description
var int
Returns
Type Description
$this

getDataQualitySpec

DataQualityScan related setting.

Returns
Type Description
Google\Cloud\Dataplex\V1\DataQualitySpec|null

hasDataQualitySpec

setDataQualitySpec

DataQualityScan related setting.

Parameter
Name Description
var Google\Cloud\Dataplex\V1\DataQualitySpec
Returns
Type Description
$this

getDataProfileSpec

DataProfileScan related setting.

Returns
Type Description
Google\Cloud\Dataplex\V1\DataProfileSpec|null

hasDataProfileSpec

setDataProfileSpec

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