Google Cloud Dataplex V1 Client - Class DataProfileSpec (0.7.0)

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

DataProfileScan related setting.

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ 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 BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10
`↳ post_scan_actions`	`Google\Cloud\Dataplex\V1\DataProfileSpec\PostScanActions` Optional. Actions to take upon job completion..
`↳ include_fields`	`Google\Cloud\Dataplex\V1\DataProfileSpec\SelectedFields` Optional. The fields to include in data profile. If not specified, all fields at the time of profile scan job execution are included, except for ones listed in `exclude_fields`.
`↳ exclude_fields`	`Google\Cloud\Dataplex\V1\DataProfileSpec\SelectedFields` Optional. The fields to exclude from data profile. If specified, the fields will be excluded from data profile, regardless of `include_fields` value.

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 BigQuery standard SQL 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 BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPostScanActions

Optional. Actions to take upon job completion..

Generated from protobuf field .google.cloud.dataplex.v1.DataProfileSpec.PostScanActions post_scan_actions = 4 [(.google.api.field_behavior) = OPTIONAL];

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

hasPostScanActions

clearPostScanActions

setPostScanActions

Optional. Actions to take upon job completion..

Generated from protobuf field .google.cloud.dataplex.v1.DataProfileSpec.PostScanActions post_scan_actions = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`Google\Cloud\Dataplex\V1\DataProfileSpec\PostScanActions`

Returns
Type	Description
`$this`

getIncludeFields

Optional. The fields to include in data profile.

If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields.

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

hasIncludeFields

clearIncludeFields

setIncludeFields

Optional. The fields to include in data profile.

If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields.

Parameter
Name	Description
`var`	`Google\Cloud\Dataplex\V1\DataProfileSpec\SelectedFields`

Returns
Type	Description
`$this`

getExcludeFields

Optional. The fields to exclude from data profile.

If specified, the fields will be excluded from data profile, regardless of include_fields value.

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

hasExcludeFields

clearExcludeFields

setExcludeFields

Optional. The fields to exclude from data profile.

If specified, the fields will be excluded from data profile, regardless of include_fields value.

Parameter
Name	Description
`var`	`Google\Cloud\Dataplex\V1\DataProfileSpec\SelectedFields`

Returns
Type	Description
`$this`