Google Cloud Dataplex V1 Client - Class DataQualitySpec (1.9.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class DataQualitySpec.

DataQualityScan related setting.

Generated from protobuf message google.cloud.dataplex.v1.DataQualitySpec

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ rules`	`array<DataQualityRule>` Required. The list of rules to evaluate against a data source. At least one rule is required.
`↳ sampling_percent`	`float` Optional. The percentage of the records to be selected from the dataset for DataScan. * * Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. * * Sampling is not applied if `sampling_percent` is not specified, 0 or 100.
`↳ row_filter`	`string` Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax. Example: col1 >= 0 AND col2 < 10
`↳ post_scan_actions`	`DataQualitySpec\PostScanActions` Optional. Actions to take upon job completion.
`↳ catalog_publishing_enabled`	`bool` Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata.

getRules

Required. The list of rules to evaluate against a data source. At least one rule is required.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setRules

Required. The list of rules to evaluate against a data source. At least one rule is required.

Parameter
Name	Description
`var`	`array<DataQualityRule>`

Returns
Type	Description
`$this`

getSamplingPercent

Optional. The percentage of the records to be selected from the dataset for DataScan.

Value can range between 0.0 and 100.0 with up to 3 significant decimal digits.
Sampling is not applied if sampling_percent is not specified, 0 or 100.

Returns
Type	Description
`float`

setSamplingPercent

Optional. The percentage of the records to be selected from the dataset for DataScan.

Value can range between 0.0 and 100.0 with up to 3 significant decimal digits.
Sampling is not applied if sampling_percent is not specified, 0 or 100.

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`

getRowFilter

Optional. A filter applied to all rows in a single DataScan job.

The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax. Example: col1 >= 0 AND col2 < 10

Returns
Type	Description
`string`

setRowFilter

Optional. A filter applied to all rows in a single DataScan job.

The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax. Example: col1 >= 0 AND col2 < 10

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPostScanActions

Optional. Actions to take upon job completion.

Returns
Type	Description
`DataQualitySpec\PostScanActions\|null`

hasPostScanActions

clearPostScanActions

setPostScanActions