Interface DataQualityRuleResultOrBuilder (1.62.0)

public interface DataQualityRuleResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAssertionRowCount()

public abstract long getAssertionRowCount()

Output only. The number of rows returned by the SQL statement in a SQL assertion rule.

This field is only valid for SQL assertion rules.

int64 assertion_row_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The assertionRowCount.

getEvaluatedCount()

public abstract long getEvaluatedCount()

Output only. 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.

    This field is not set for rule SqlAssertion.

int64 evaluated_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The evaluatedCount.

getFailingRowsQuery()

public abstract String getFailingRowsQuery()

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

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

string failing_rows_query = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The failingRowsQuery.

getFailingRowsQueryBytes()

public abstract ByteString getFailingRowsQueryBytes()

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

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

string failing_rows_query = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for failingRowsQuery.

getNullCount()

public abstract long getNullCount()

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

int64 null_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The nullCount.

getPassRatio()

public abstract double getPassRatio()

Output only. The ratio of passed_count / evaluated_count.

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

double pass_ratio = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
double

The passRatio.

getPassed()

public abstract boolean getPassed()

Output only. Whether the rule passed or failed.

bool passed = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The passed.

getPassedCount()

public abstract long getPassedCount()

Output only. The number of rows which passed a rule evaluation.

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

This field is not set for rule SqlAssertion.

int64 passed_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The passedCount.

getRule()

public abstract DataQualityRule getRule()

Output only. The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRule

The rule.

getRuleOrBuilder()

public abstract DataQualityRuleOrBuilder getRuleOrBuilder()

Output only. The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleOrBuilder

hasRule()

public abstract boolean hasRule()

Output only. The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the rule field is set.