Google Cloud Dataplex V1 Client - Class DataQualityRule (0.16.1)

Version 0.16.1

• 1.0.0 (latest)
• 1.0.0-RC1
• 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 Row-level rule which evaluates whether each column value lies between a specified range.
↳ non_null_expectation	Google\Cloud\Dataplex\V1\DataQualityRule\NonNullExpectation Row-level rule which evaluates whether each column value is null.
↳ set_expectation	Google\Cloud\Dataplex\V1\DataQualityRule\SetExpectation Row-level rule which evaluates whether each column value is contained by a specified set.
↳ regex_expectation	Google\Cloud\Dataplex\V1\DataQualityRule\RegexExpectation Row-level rule which evaluates whether each column value matches a specified regex.
↳ uniqueness_expectation	Google\Cloud\Dataplex\V1\DataQualityRule\UniquenessExpectation Row-level rule which evaluates whether each column value is unique.
↳ statistic_range_expectation	Google\Cloud\Dataplex\V1\DataQualityRule\StatisticRangeExpectation Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
↳ row_condition_expectation	Google\Cloud\Dataplex\V1\DataQualityRule\RowConditionExpectation Row-level rule which evaluates whether each row in a table passes the specified condition.
↳ table_condition_expectation	Google\Cloud\Dataplex\V1\DataQualityRule\TableConditionExpectation Aggregate rule which evaluates whether the provided expression is true for a table.
↳ sql_assertion	Google\Cloud\Dataplex\V1\DataQualityRule\SqlAssertion Aggregate rule which evaluates the number of rows returned for the provided statement.
↳ 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. This field is only valid for the following type of rules: * RangeExpectation * RegexExpectation * SetExpectation * UniquenessExpectation
↳ 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). This field is only valid for row-level type rules.
↳ name	string Optional. A mutable name for the rule. * The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). * The maximum length is 63 characters. * Must start with a letter. * Must end with a number or a letter.
↳ description	string Optional. Description of the rule. * The maximum length is 1,024 characters.

getRangeExpectation

Row-level rule which evaluates whether each column value lies between a specified range.

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

hasRangeExpectation

setRangeExpectation

Row-level 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

Row-level rule which evaluates whether each column value is null.

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

hasNonNullExpectation

setNonNullExpectation

Row-level rule which evaluates whether each column value is null.

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

Returns
Type	Description
$this

getSetExpectation

Row-level 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

Row-level 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

Row-level rule which evaluates whether each column value matches a specified regex.

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

hasRegexExpectation

setRegexExpectation

Row-level 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

Row-level rule which evaluates whether each column value is unique.

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

hasUniquenessExpectation

setUniquenessExpectation

Row-level rule which evaluates whether each column value is unique.

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

Returns
Type	Description
$this

getStatisticRangeExpectation

Aggregate 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

Aggregate 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

Row-level rule which evaluates whether each row in a table passes the specified condition.

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

hasRowConditionExpectation

setRowConditionExpectation

Row-level rule which evaluates whether each row in a table passes the specified condition.

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

Returns
Type	Description
$this

getTableConditionExpectation

Aggregate rule which evaluates whether the provided expression is true for a table.

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

hasTableConditionExpectation

setTableConditionExpectation

Aggregate rule which evaluates whether the provided expression is true for a table.

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

Returns
Type	Description
$this

getSqlAssertion

Aggregate rule which evaluates the number of rows returned for the provided statement.

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

hasSqlAssertion

setSqlAssertion

Aggregate rule which evaluates the number of rows returned for the provided statement.

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

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.

This field is only valid for the following type of rules:

• RangeExpectation
• RegexExpectation
• SetExpectation
• UniquenessExpectation

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.

This field is only valid for the following type of rules:

• RangeExpectation
• RegexExpectation
• SetExpectation
• UniquenessExpectation

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). This field is only valid for row-level type rules.

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). This field is only valid for row-level type rules.

Parameter
Name	Description
var	float

Returns
Type	Description
$this

getName

Optional. A mutable name for the rule.

• The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-).
• The maximum length is 63 characters.
• Must start with a letter.
• Must end with a number or a letter.

Returns
Type	Description
string

setName

Optional. A mutable name for the rule.

• The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-).
• The maximum length is 63 characters.
• Must start with a letter.
• Must end with a number or a letter.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDescription

Optional. Description of the rule.

• The maximum length is 1,024 characters.

Returns
Type	Description
string

setDescription

Optional. Description of the rule.

• The maximum length is 1,024 characters.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRuleType

Returns
Type	Description
string