Google Cloud Dataplex V1 Client - Class DataQualityRuleResult (0.11.1)

Version 0.11.1

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

DataQualityRuleResult provides a more detailed, per-rule view of the results.

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ rule	Google\Cloud\Dataplex\V1\DataQualityRule The rule specified in the DataQualitySpec, as is.
↳ passed	bool Whether the rule passed or failed.
↳ evaluated_count	int|string The number of rows a rule was evaluated against. This field is only valid for row-level type rules. Evaluated count can be configured to either * include all rows (default) - with null rows automatically failing rule evaluation, or * exclude null rows from the evaluated_count, by setting ignore_nulls = true.
↳ passed_count	int|string The number of rows which passed a rule evaluation. This field is only valid for row-level type rules.
↳ null_count	int|string The number of rows with null values in the specified column.
↳ pass_ratio	float The ratio of passed_count / evaluated_count. This field is only valid for row-level type rules.
↳ failing_rows_query	string The query to find rows that did not pass this rule. This field is only valid for row-level type rules.

getRule

The rule specified in the DataQualitySpec, as is.

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

hasRule

clearRule

setRule

The rule specified in the DataQualitySpec, as is.

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

Returns
Type	Description
$this

getPassed

Whether the rule passed or failed.

Returns
Type	Description
bool

setPassed

Whether the rule passed or failed.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getEvaluatedCount

The number of rows a rule was evaluated against.

This field is only valid for row-level type rules. Evaluated count can be configured to either

• include all rows (default) - with null rows automatically failing rule evaluation, or
• exclude null rows from the evaluated_count, by setting ignore_nulls = true.

Returns
Type	Description
int|string

setEvaluatedCount

The number of rows a rule was evaluated against.

This field is only valid for row-level type rules. Evaluated count can be configured to either

• include all rows (default) - with null rows automatically failing rule evaluation, or
• exclude null rows from the evaluated_count, by setting ignore_nulls = true.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getPassedCount

The number of rows which passed a rule evaluation.

This field is only valid for row-level type rules.

Returns
Type	Description
int|string

setPassedCount

The number of rows which passed a rule evaluation.

This field is only valid for row-level type rules.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getNullCount

The number of rows with null values in the specified column.

Returns
Type	Description
int|string

setNullCount

The number of rows with null values in the specified column.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getPassRatio

The ratio of passed_count / evaluated_count.

This field is only valid for row-level type rules.

Returns
Type	Description
float

setPassRatio

The ratio of passed_count / evaluated_count.

This field is only valid for row-level type rules.

Parameter
Name	Description
var	float

Returns
Type	Description
$this

getFailingRowsQuery

The query to find rows that did not pass this rule.

This field is only valid for row-level type rules.

Returns
Type	Description
string

setFailingRowsQuery

The query to find rows that did not pass this rule.

This field is only valid for row-level type rules.

Parameter
Name	Description
var	string

Returns
Type	Description
$this