Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualityRuleResult

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dataplex_v1/classes.rb,
lib/google/apis/dataplex_v1/representations.rb,
lib/google/apis/dataplex_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1DataQualityRuleResult

Returns a new instance of GoogleCloudDataplexV1DataQualityRuleResult.



1766
1767
1768
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1766

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#evaluated_count ⇒ Fixnum

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. Corresponds to the JSON property evaluatedCount

Returns:

  • (Fixnum) 


1730
1731
1732
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1730

def evaluated_count
  @evaluated_count
end

#failing_rows_query ⇒ String

The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules. Corresponds to the JSON property failingRowsQuery

Returns:

  • (String) 


1736
1737
1738
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1736

def failing_rows_query
  @failing_rows_query
end

#null_count ⇒ Fixnum

The number of rows with null values in the specified column. Corresponds to the JSON property nullCount

Returns:

  • (Fixnum) 


1741
1742
1743
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1741

def null_count
  @null_count
end

#pass_ratio ⇒ Float

The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules. Corresponds to the JSON property passRatio

Returns:

  • (Float) 


1747
1748
1749
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1747

def pass_ratio
  @pass_ratio
end

#passed ⇒ Boolean Also known as: passed?

Whether the rule passed or failed. Corresponds to the JSON property passed

Returns:

  • (Boolean) 


1752
1753
1754
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1752

def passed
  @passed
end

#passed_count ⇒ Fixnum

The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules. Corresponds to the JSON property passedCount

Returns:

  • (Fixnum) 


1759
1760
1761
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1759

def passed_count
  @passed_count
end

#rule ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualityRule

A rule captures data quality intent about a data source. Corresponds to the JSON property rule

Returns:



1764
1765
1766
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1764

def rule
  @rule
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1771

def update!(**args)
  @evaluated_count = args[:evaluated_count] if args.key?(:evaluated_count)
  @failing_rows_query = args[:failing_rows_query] if args.key?(:failing_rows_query)
  @null_count = args[:null_count] if args.key?(:null_count)
  @pass_ratio = args[:pass_ratio] if args.key?(:pass_ratio)
  @passed = args[:passed] if args.key?(:passed)
  @passed_count = args[:passed_count] if args.key?(:passed_count)
  @rule = args[:rule] if args.key?(:rule)
end