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.



2492
2493
2494
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2492

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

Instance Attribute Details

#assertion_row_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2448
2449
2450
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2448

def assertion_row_count
  @assertion_row_count
end

#evaluated_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2456
2457
2458
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2456

def evaluated_count
  @evaluated_count
end

#failing_rows_query ⇒ String

The query to find rows that did not pass this rule.This field is only valid for row-level type rules. Corresponds to the JSON property failingRowsQuery

Returns:

  • (String) 


2462
2463
2464
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2462

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) 


2467
2468
2469
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2467

def null_count
  @null_count
end

#pass_ratio ⇒ Float

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

Returns:

  • (Float) 


2473
2474
2475
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2473

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) 


2478
2479
2480
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2478

def passed
  @passed
end

#passed_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2485
2486
2487
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2485

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:



2490
2491
2492
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2490

def rule
  @rule
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2497

def update!(**args)
  @assertion_row_count = args[:assertion_row_count] if args.key?(:assertion_row_count)
  @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