Google Cloud Dataplex V1 Client - Class DataQualityRule (0.6.0)

Version 0.6.0

• 1.1.1 (latest)
• 1.1.0
• 1.0.1
• 0.16.1
• 0.15.1
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.0
• 0.2.3
• 0.1.6

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

A rule captures data quality intent about a data source.

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ range_expectation	Google\Cloud\Dataplex\V1\DataQualityRule\RangeExpectation ColumnMap rule which evaluates whether each column value lies between a specified range.
↳ non_null_expectation	Google\Cloud\Dataplex\V1\DataQualityRule\NonNullExpectation ColumnMap rule which evaluates whether each column value is null.
↳ set_expectation	Google\Cloud\Dataplex\V1\DataQualityRule\SetExpectation ColumnMap rule which evaluates whether each column value is contained by a specified set.
↳ regex_expectation	Google\Cloud\Dataplex\V1\DataQualityRule\RegexExpectation ColumnMap rule which evaluates whether each column value matches a specified regex.
↳ uniqueness_expectation	Google\Cloud\Dataplex\V1\DataQualityRule\UniquenessExpectation ColumnAggregate rule which evaluates whether the column has duplicates.
↳ statistic_range_expectation	Google\Cloud\Dataplex\V1\DataQualityRule\StatisticRangeExpectation ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
↳ row_condition_expectation	Google\Cloud\Dataplex\V1\DataQualityRule\RowConditionExpectation Table rule which evaluates whether each row passes the specified condition.
↳ table_condition_expectation	Google\Cloud\Dataplex\V1\DataQualityRule\TableConditionExpectation Table rule which evaluates whether the provided expression is true.
↳ column	string Optional. The unnested column which this rule is evaluated against.
↳ ignore_null	bool Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.
↳ dimension	string Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]
↳ threshold	float Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of [0.0, 1.0]. 0 indicates default value (i.e. 1.0).

getRangeExpectation

ColumnMap rule which evaluates whether each column value lies between a specified range.

Returns
Type	Description
Google\Cloud\Dataplex\V1\DataQualityRule\RangeExpectation|null

hasRangeExpectation

setRangeExpectation

ColumnMap rule which evaluates whether each column value lies between a specified range.

Parameter
Name	Description
var	Google\Cloud\Dataplex\V1\DataQualityRule\RangeExpectation

Returns
Type	Description
$this

getNonNullExpectation

ColumnMap rule which evaluates whether each column value is null.

Returns
Type	Description
Google\Cloud\Dataplex\V1\DataQualityRule\NonNullExpectation|null

hasNonNullExpectation

setNonNullExpectation

ColumnMap rule which evaluates whether each column value is null.

Parameter
Name	Description
var	Google\Cloud\Dataplex\V1\DataQualityRule\NonNullExpectation

Returns
Type	Description
$this

getSetExpectation

ColumnMap rule which evaluates whether each column value is contained by a specified set.

Returns
Type	Description
Google\Cloud\Dataplex\V1\DataQualityRule\SetExpectation|null

hasSetExpectation

setSetExpectation

ColumnMap rule which evaluates whether each column value is contained by a specified set.

Parameter
Name	Description
var	Google\Cloud\Dataplex\V1\DataQualityRule\SetExpectation

Returns
Type	Description
$this

getRegexExpectation

ColumnMap rule which evaluates whether each column value matches a specified regex.

Returns
Type	Description
Google\Cloud\Dataplex\V1\DataQualityRule\RegexExpectation|null

hasRegexExpectation

setRegexExpectation

ColumnMap rule which evaluates whether each column value matches a specified regex.

Parameter
Name	Description
var	Google\Cloud\Dataplex\V1\DataQualityRule\RegexExpectation

Returns
Type	Description
$this

getUniquenessExpectation

ColumnAggregate rule which evaluates whether the column has duplicates.

Returns
Type	Description
Google\Cloud\Dataplex\V1\DataQualityRule\UniquenessExpectation|null

hasUniquenessExpectation

setUniquenessExpectation

ColumnAggregate rule which evaluates whether the column has duplicates.

Parameter
Name	Description
var	Google\Cloud\Dataplex\V1\DataQualityRule\UniquenessExpectation

Returns
Type	Description
$this

getStatisticRangeExpectation

ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.

Returns
Type	Description
Google\Cloud\Dataplex\V1\DataQualityRule\StatisticRangeExpectation|null

hasStatisticRangeExpectation

setStatisticRangeExpectation

ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.

Parameter
Name	Description
var	Google\Cloud\Dataplex\V1\DataQualityRule\StatisticRangeExpectation

Returns
Type	Description
$this

getRowConditionExpectation

Table rule which evaluates whether each row passes the specified condition.

Returns
Type	Description
Google\Cloud\Dataplex\V1\DataQualityRule\RowConditionExpectation|null

hasRowConditionExpectation

setRowConditionExpectation

Table rule which evaluates whether each row passes the specified condition.

Parameter
Name	Description
var	Google\Cloud\Dataplex\V1\DataQualityRule\RowConditionExpectation

Returns
Type	Description
$this

getTableConditionExpectation

Table rule which evaluates whether the provided expression is true.

Returns
Type	Description
Google\Cloud\Dataplex\V1\DataQualityRule\TableConditionExpectation|null

hasTableConditionExpectation

setTableConditionExpectation

Table rule which evaluates whether the provided expression is true.

Parameter
Name	Description
var	Google\Cloud\Dataplex\V1\DataQualityRule\TableConditionExpectation

Returns
Type	Description
$this

getColumn

Optional. The unnested column which this rule is evaluated against.

Returns
Type	Description
string

setColumn

Optional. The unnested column which this rule is evaluated against.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getIgnoreNull

Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.

Only applicable to ColumnMap rules.

Returns
Type	Description
bool

setIgnoreNull

Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.

Only applicable to ColumnMap rules.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getDimension

Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]

Returns
Type	Description
string

setDimension

Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getThreshold

Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of [0.0, 1.0].

0 indicates default value (i.e. 1.0).

Returns
Type	Description
float

setThreshold

Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of [0.0, 1.0].

0 indicates default value (i.e. 1.0).

Parameter
Name	Description
var	float

Returns
Type	Description
$this

getRuleType

Returns
Type	Description
string