Package com.google.cloud.dataplex.v1

Class DataQualityRuleResult

  • All Implemented Interfaces:
    DataQualityRuleResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class DataQualityRuleResult
extends com.google.protobuf.GeneratedMessageV3
implements DataQualityRuleResultOrBuilder
     DataQualityRuleResult provides a more detailed, per-rule view of the results.
    Protobuf type google.cloud.dataplex.v1.DataQualityRuleResult
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • hasRule

        public boolean hasRule()
         The rule specified in the DataQualitySpec, as is.
        .google.cloud.dataplex.v1.DataQualityRule rule = 1;
        Specified by:
        hasRule in interface DataQualityRuleResultOrBuilder
        Returns:
        Whether the rule field is set.

      • getEvaluatedCount

        public long getEvaluatedCount()
         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`.
        int64 evaluated_count = 9;
        Specified by:
        getEvaluatedCount in interface DataQualityRuleResultOrBuilder
        Returns:
        The evaluatedCount.

      • getPassedCount

        public long getPassedCount()
         The number of rows which passed a rule evaluation.

 This field is only valid for row-level type rules.
        int64 passed_count = 8;
        Specified by:
        getPassedCount in interface DataQualityRuleResultOrBuilder
        Returns:
        The passedCount.

      • getNullCount

        public long getNullCount()
         The number of rows with null values in the specified column.
        int64 null_count = 5;
        Specified by:
        getNullCount in interface DataQualityRuleResultOrBuilder
        Returns:
        The nullCount.

      • getPassRatio

        public double getPassRatio()
         The ratio of **passed_count / evaluated_count**.

 This field is only valid for row-level type rules.
        double pass_ratio = 6;
        Specified by:
        getPassRatio in interface DataQualityRuleResultOrBuilder
        Returns:
        The passRatio.

      • getFailingRowsQuery

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

      • getFailingRowsQueryBytes

        public com.google.protobuf.ByteString getFailingRowsQueryBytes()
         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;
        Specified by:
        getFailingRowsQueryBytes in interface DataQualityRuleResultOrBuilder
        Returns:
        The bytes for failingRowsQuery.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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

      • newBuilderForType

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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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