/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dataplex/v1/data_quality.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.dataplex.v1;
public interface DataQualityRuleResultOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dataplex.v1.DataQualityRuleResult)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The rule specified in the DataQualitySpec, as is.
*
*
* .google.cloud.dataplex.v1.DataQualityRule rule = 1;
*
* @return Whether the rule field is set.
*/
boolean hasRule();
/**
*
*
*
* The rule specified in the DataQualitySpec, as is.
*
*
* .google.cloud.dataplex.v1.DataQualityRule rule = 1;
*
* @return The rule.
*/
com.google.cloud.dataplex.v1.DataQualityRule getRule();
/**
*
*
*
* The rule specified in the DataQualitySpec, as is.
*
*
* .google.cloud.dataplex.v1.DataQualityRule rule = 1;
*/
com.google.cloud.dataplex.v1.DataQualityRuleOrBuilder getRuleOrBuilder();
/**
*
*
*
* Whether the rule passed or failed.
*
*
* bool passed = 7;
*
* @return The passed.
*/
boolean getPassed();
/**
*
*
*
* 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;
*
* @return The evaluatedCount.
*/
long getEvaluatedCount();
/**
*
*
*
* The number of rows which passed a rule evaluation.
*
* This field is only valid for row-level type rules.
*
*
* int64 passed_count = 8;
*
* @return The passedCount.
*/
long getPassedCount();
/**
*
*
*
* The number of rows with null values in the specified column.
*
*
* int64 null_count = 5;
*
* @return The nullCount.
*/
long getNullCount();
/**
*
*
*
* The ratio of **passed_count / evaluated_count**.
*
* This field is only valid for row-level type rules.
*
*
* double pass_ratio = 6;
*
* @return The passRatio.
*/
double getPassRatio();
/**
*
*
*
* 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;
*
* @return The failingRowsQuery.
*/
java.lang.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;
*
* @return The bytes for failingRowsQuery.
*/
com.google.protobuf.ByteString getFailingRowsQueryBytes();
/**
*
*
*
* 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];
*
* @return The assertionRowCount.
*/
long getAssertionRowCount();
}
