Class: Google::Cloud::Dataplex::V1::DataQualityRuleResult

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/data_quality.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#evaluated_count ⇒ ::Integer

Returns 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:

  • (::Integer) —

    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.


171
172
173
174
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 171

class DataQualityRuleResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#failing_rows_query ⇒ ::String

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

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

Returns:

  • (::String) —

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

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



171
172
173
174
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 171

class DataQualityRuleResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#null_count ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



171
172
173
174
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 171

class DataQualityRuleResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#pass_ratio ⇒ ::Float

Returns The ratio of passed_count / evaluated_count.

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

Returns:

  • (::Float) —

    The ratio of passed_count / evaluated_count.

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



171
172
173
174
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 171

class DataQualityRuleResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#passed ⇒ ::Boolean

Returns Whether the rule passed or failed.

Returns:

  • (::Boolean) —

    Whether the rule passed or failed.



171
172
173
174
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 171

class DataQualityRuleResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#passed_count ⇒ ::Integer

Returns The number of rows which passed a rule evaluation.

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

Returns:

  • (::Integer) —

    The number of rows which passed a rule evaluation.

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



171
172
173
174
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 171

class DataQualityRuleResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#rule ⇒ ::Google::Cloud::Dataplex::V1::DataQualityRule

Returns The rule specified in the DataQualitySpec, as is.

Returns:



171
172
173
174
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 171

class DataQualityRuleResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end