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
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ rule
↳ 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 ColumnMap 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 ColumnMap 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 ColumnMap type rules.
↳ failing_rows_query
string
The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.
getRule
The rule specified in the DataQualitySpec, as is.
hasRule
clearRule
setRule
The rule specified in the DataQualitySpec, as is.
$this
getPassed
Whether the rule passed or failed.
bool
setPassed
Whether the rule passed or failed.
var
bool
$this
getEvaluatedCount
The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules.
Evaluated count can be configured to either
- include all rows (default) - with
nullrows automatically failing rule evaluation, or - exclude
nullrows from theevaluated_count, by settingignore_nulls = true.
int|string
setEvaluatedCount
The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules.
Evaluated count can be configured to either
- include all rows (default) - with
nullrows automatically failing rule evaluation, or - exclude
nullrows from theevaluated_count, by settingignore_nulls = true.
var
int|string
$this
getPassedCount
The number of rows which passed a rule evaluation.
This field is only valid for ColumnMap type rules.
int|string
setPassedCount
The number of rows which passed a rule evaluation.
This field is only valid for ColumnMap type rules.
var
int|string
$this
getNullCount
The number of rows with null values in the specified column.
int|string
setNullCount
The number of rows with null values in the specified column.
var
int|string
$this
getPassRatio
The ratio of passed_count / evaluated_count.
This field is only valid for ColumnMap type rules.
float
setPassRatio
The ratio of passed_count / evaluated_count.
This field is only valid for ColumnMap type rules.
var
float
$this
getFailingRowsQuery
The query to find rows that did not pass this rule.
Only applies to ColumnMap and RowCondition rules.
string
setFailingRowsQuery
The query to find rows that did not pass this rule.
Only applies to ColumnMap and RowCondition rules.
var
string
$this
