Package com.google.cloud.dataplex.v1

Class DataQualityRuleResult

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataplex.v1.DataQualityRuleResult
All Implemented Interfaces:
DataQualityRuleResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DataQualityRuleResult extends com.google.protobuf.GeneratedMessage implements DataQualityRuleResultOrBuilder
 DataQualityRuleResult provides a more detailed, per-rule view of the results.
Protobuf type google.cloud.dataplex.v1.DataQualityRuleResult
See Also:

  • Field Details

    • RULE_FIELD_NUMBER

      public static final int RULE_FIELD_NUMBER
      See Also:

    • PASSED_FIELD_NUMBER

      public static final int PASSED_FIELD_NUMBER
      See Also:

    • EVALUATED_COUNT_FIELD_NUMBER

      public static final int EVALUATED_COUNT_FIELD_NUMBER
      See Also:

    • PASSED_COUNT_FIELD_NUMBER

      public static final int PASSED_COUNT_FIELD_NUMBER
      See Also:

    • NULL_COUNT_FIELD_NUMBER

      public static final int NULL_COUNT_FIELD_NUMBER
      See Also:

    • PASS_RATIO_FIELD_NUMBER

      public static final int PASS_RATIO_FIELD_NUMBER
      See Also:

    • FAILING_ROWS_QUERY_FIELD_NUMBER

      public static final int FAILING_ROWS_QUERY_FIELD_NUMBER
      See Also:

    • ASSERTION_ROW_COUNT_FIELD_NUMBER

      public static final int ASSERTION_ROW_COUNT_FIELD_NUMBER
      See Also:

    • DEBUG_QUERIES_RESULT_SETS_FIELD_NUMBER

      public static final int DEBUG_QUERIES_RESULT_SETS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasRule

      public 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];
      Specified by:
      hasRule in interface DataQualityRuleResultOrBuilder
      Returns:
      Whether the rule field is set.

    • getRule

      public 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];
      Specified by:
      getRule in interface DataQualityRuleResultOrBuilder
      Returns:
      The rule.

    • getRuleOrBuilder

      public 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];
      Specified by:
      getRuleOrBuilder in interface DataQualityRuleResultOrBuilder

    • getPassed

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

    • getEvaluatedCount

      public 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];
      Specified by:
      getEvaluatedCount in interface DataQualityRuleResultOrBuilder
      Returns:
      The evaluatedCount.

    • getPassedCount

      public 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];
      Specified by:
      getPassedCount in interface DataQualityRuleResultOrBuilder
      Returns:
      The passedCount.

    • getNullCount

      public 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];
      Specified by:
      getNullCount in interface DataQualityRuleResultOrBuilder
      Returns:
      The nullCount.

    • getPassRatio

      public 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];
      Specified by:
      getPassRatio in interface DataQualityRuleResultOrBuilder
      Returns:
      The passRatio.

    • getFailingRowsQuery

      public 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];
      Specified by:
      getFailingRowsQuery in interface DataQualityRuleResultOrBuilder
      Returns:
      The failingRowsQuery.

    • getFailingRowsQueryBytes

      public 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];
      Specified by:
      getFailingRowsQueryBytes in interface DataQualityRuleResultOrBuilder
      Returns:
      The bytes for failingRowsQuery.

    • getAssertionRowCount

      public 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];
      Specified by:
      getAssertionRowCount in interface DataQualityRuleResultOrBuilder
      Returns:
      The assertionRowCount.

    • getDebugQueriesResultSetsList

      public 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];
      Specified by:
      getDebugQueriesResultSetsList in interface DataQualityRuleResultOrBuilder

    • getDebugQueriesResultSetsOrBuilderList

      public 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];
      Specified by:
      getDebugQueriesResultSetsOrBuilderList in interface DataQualityRuleResultOrBuilder

    • getDebugQueriesResultSetsCount

      public 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];
      Specified by:
      getDebugQueriesResultSetsCount in interface DataQualityRuleResultOrBuilder

    • getDebugQueriesResultSets

      public 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];
      Specified by:
      getDebugQueriesResultSets in interface DataQualityRuleResultOrBuilder

    • getDebugQueriesResultSetsOrBuilder

      public 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];
      Specified by:
      getDebugQueriesResultSetsOrBuilder in interface DataQualityRuleResultOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static DataQualityRuleResult parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataQualityRuleResult parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataQualityRuleResult parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataQualityRuleResult parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataQualityRuleResult parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataQualityRuleResult parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataQualityRuleResult parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataQualityRuleResult parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataQualityRuleResult parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataQualityRuleResult parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataQualityRuleResult parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataQualityRuleResult parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public DataQualityRuleResult.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static DataQualityRuleResult.Builder newBuilder()

    • newBuilder

      public static DataQualityRuleResult.Builder newBuilder(DataQualityRuleResult prototype)

    • toBuilder

      public DataQualityRuleResult.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected DataQualityRuleResult.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static DataQualityRuleResult getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DataQualityRuleResult> parser()

    • getParserForType

      public com.google.protobuf.Parser<DataQualityRuleResult> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public DataQualityRuleResult getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder