Package com.google.cloud.dataplex.v1

Interface DataQualityRuleResultOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DataQualityRuleResult, DataQualityRuleResult.Builder
@Generated public interface DataQualityRuleResultOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasRule

      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:
      Whether the rule field is set.

    • getRule

      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:
      The rule.

    • getRuleOrBuilder

      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];

    • getPassed

      boolean getPassed()
       Output only. Whether the rule passed or failed.
      bool passed = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The passed.

    • getEvaluatedCount

      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:
      The evaluatedCount.

    • getPassedCount

      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:
      The passedCount.

    • getNullCount

      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:
      The nullCount.

    • getPassRatio

      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:
      The passRatio.

    • getFailingRowsQuery

      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:
      The failingRowsQuery.

    • getFailingRowsQueryBytes

      com.google.protobuf.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:
      The bytes for failingRowsQuery.

    • getAssertionRowCount

      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:
      The assertionRowCount.

    • getDebugQueriesResultSetsList

      List<DataQualityRuleResult.DebugQueryResultSet> getDebugQueriesResultSetsList()
       Output only. Contains the results of all debug queries for this rule.
 The number of result sets will correspond to the number of
 [debug_queries][google.cloud.dataplex.v1.DataQualityRule.debug_queries].
      repeated .google.cloud.dataplex.v1.DataQualityRuleResult.DebugQueryResultSet debug_queries_result_sets = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getDebugQueriesResultSets

      DataQualityRuleResult.DebugQueryResultSet getDebugQueriesResultSets(int index)
       Output only. Contains the results of all debug queries for this rule.
 The number of result sets will correspond to the number of
 [debug_queries][google.cloud.dataplex.v1.DataQualityRule.debug_queries].
      repeated .google.cloud.dataplex.v1.DataQualityRuleResult.DebugQueryResultSet debug_queries_result_sets = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getDebugQueriesResultSetsCount

      int getDebugQueriesResultSetsCount()
       Output only. Contains the results of all debug queries for this rule.
 The number of result sets will correspond to the number of
 [debug_queries][google.cloud.dataplex.v1.DataQualityRule.debug_queries].
      repeated .google.cloud.dataplex.v1.DataQualityRuleResult.DebugQueryResultSet debug_queries_result_sets = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getDebugQueriesResultSetsOrBuilderList

      List<? extends DataQualityRuleResult.DebugQueryResultSetOrBuilder> getDebugQueriesResultSetsOrBuilderList()
       Output only. Contains the results of all debug queries for this rule.
 The number of result sets will correspond to the number of
 [debug_queries][google.cloud.dataplex.v1.DataQualityRule.debug_queries].
      repeated .google.cloud.dataplex.v1.DataQualityRuleResult.DebugQueryResultSet debug_queries_result_sets = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getDebugQueriesResultSetsOrBuilder

      DataQualityRuleResult.DebugQueryResultSetOrBuilder getDebugQueriesResultSetsOrBuilder(int index)
       Output only. Contains the results of all debug queries for this rule.
 The number of result sets will correspond to the number of
 [debug_queries][google.cloud.dataplex.v1.DataQualityRule.debug_queries].
      repeated .google.cloud.dataplex.v1.DataQualityRuleResult.DebugQueryResultSet debug_queries_result_sets = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];