Dataplex V1 API - Class Google::Cloud::Dataplex::V1::DataQualityRuleResult (v0.8.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::DataQualityRuleResult.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#evaluated_count

def evaluated_count() -> ::Integer
Returns
  • (::Integer) —

    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.

#evaluated_count=

def evaluated_count=(value) -> ::Integer
Parameter
  • value (::Integer) —

    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.
Returns
  • (::Integer) —

    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.

#failing_rows_query

def failing_rows_query() -> ::String
Returns
  • (::String) — The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.

#failing_rows_query=

def failing_rows_query=(value) -> ::String
Parameter
  • value (::String) — The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.
Returns
  • (::String) — The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.

#null_count

def null_count() -> ::Integer
Returns
  • (::Integer) — The number of rows with null values in the specified column.

#null_count=

def null_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The number of rows with null values in the specified column.
Returns
  • (::Integer) — The number of rows with null values in the specified column.

#pass_ratio

def pass_ratio() -> ::Float
Returns
  • (::Float) — The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.

#pass_ratio=

def pass_ratio=(value) -> ::Float
Parameter
  • value (::Float) — The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.
Returns
  • (::Float) — The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.

#passed

def passed() -> ::Boolean
Returns
  • (::Boolean) — Whether the rule passed or failed.

#passed=

def passed=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether the rule passed or failed.
Returns
  • (::Boolean) — Whether the rule passed or failed.

#passed_count

def passed_count() -> ::Integer
Returns
  • (::Integer) — The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.

#passed_count=

def passed_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.
Returns
  • (::Integer) — The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.

#rule

def rule() -> ::Google::Cloud::Dataplex::V1::DataQualityRule
Returns

#rule=

def rule=(value) -> ::Google::Cloud::Dataplex::V1::DataQualityRule
Parameter
Returns