Package com.google.cloud.dataplex.v1

Interface DataQualityRuleOrBuilder

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

  • Method Details

    • hasRangeExpectation

      boolean hasRangeExpectation()
       Row-level rule which evaluates whether each column value lies between a
 specified range.
      .google.cloud.dataplex.v1.DataQualityRule.RangeExpectation range_expectation = 1;
      Returns:
      Whether the rangeExpectation field is set.

    • getRangeExpectation

      DataQualityRule.RangeExpectation getRangeExpectation()
       Row-level rule which evaluates whether each column value lies between a
 specified range.
      .google.cloud.dataplex.v1.DataQualityRule.RangeExpectation range_expectation = 1;
      Returns:
      The rangeExpectation.

    • getRangeExpectationOrBuilder

      DataQualityRule.RangeExpectationOrBuilder getRangeExpectationOrBuilder()
       Row-level rule which evaluates whether each column value lies between a
 specified range.
      .google.cloud.dataplex.v1.DataQualityRule.RangeExpectation range_expectation = 1;

    • hasNonNullExpectation

      boolean hasNonNullExpectation()
       Row-level rule which evaluates whether each column value is null.
      .google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation non_null_expectation = 2;
      Returns:
      Whether the nonNullExpectation field is set.

    • getNonNullExpectation

      DataQualityRule.NonNullExpectation getNonNullExpectation()
       Row-level rule which evaluates whether each column value is null.
      .google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation non_null_expectation = 2;
      Returns:
      The nonNullExpectation.

    • getNonNullExpectationOrBuilder

      DataQualityRule.NonNullExpectationOrBuilder getNonNullExpectationOrBuilder()
       Row-level rule which evaluates whether each column value is null.
      .google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation non_null_expectation = 2;

    • hasSetExpectation

      boolean hasSetExpectation()
       Row-level rule which evaluates whether each column value is contained by
 a specified set.
      .google.cloud.dataplex.v1.DataQualityRule.SetExpectation set_expectation = 3;
      Returns:
      Whether the setExpectation field is set.

    • getSetExpectation

      DataQualityRule.SetExpectation getSetExpectation()
       Row-level rule which evaluates whether each column value is contained by
 a specified set.
      .google.cloud.dataplex.v1.DataQualityRule.SetExpectation set_expectation = 3;
      Returns:
      The setExpectation.

    • getSetExpectationOrBuilder

      DataQualityRule.SetExpectationOrBuilder getSetExpectationOrBuilder()
       Row-level rule which evaluates whether each column value is contained by
 a specified set.
      .google.cloud.dataplex.v1.DataQualityRule.SetExpectation set_expectation = 3;

    • hasRegexExpectation

      boolean hasRegexExpectation()
       Row-level rule which evaluates whether each column value matches a
 specified regex.
      .google.cloud.dataplex.v1.DataQualityRule.RegexExpectation regex_expectation = 4;
      Returns:
      Whether the regexExpectation field is set.

    • getRegexExpectation

      DataQualityRule.RegexExpectation getRegexExpectation()
       Row-level rule which evaluates whether each column value matches a
 specified regex.
      .google.cloud.dataplex.v1.DataQualityRule.RegexExpectation regex_expectation = 4;
      Returns:
      The regexExpectation.

    • getRegexExpectationOrBuilder

      DataQualityRule.RegexExpectationOrBuilder getRegexExpectationOrBuilder()
       Row-level rule which evaluates whether each column value matches a
 specified regex.
      .google.cloud.dataplex.v1.DataQualityRule.RegexExpectation regex_expectation = 4;

    • hasUniquenessExpectation

      boolean hasUniquenessExpectation()
       Row-level rule which evaluates whether each column value is unique.
      .google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;
      Returns:
      Whether the uniquenessExpectation field is set.

    • getUniquenessExpectation

      DataQualityRule.UniquenessExpectation getUniquenessExpectation()
       Row-level rule which evaluates whether each column value is unique.
      .google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;
      Returns:
      The uniquenessExpectation.

    • getUniquenessExpectationOrBuilder

      DataQualityRule.UniquenessExpectationOrBuilder getUniquenessExpectationOrBuilder()
       Row-level rule which evaluates whether each column value is unique.
      .google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;

    • hasStatisticRangeExpectation

      boolean hasStatisticRangeExpectation()
       Aggregate rule which evaluates whether the column aggregate
 statistic lies between a specified range.
      .google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation statistic_range_expectation = 101;
      Returns:
      Whether the statisticRangeExpectation field is set.

    • getStatisticRangeExpectation

      DataQualityRule.StatisticRangeExpectation getStatisticRangeExpectation()
       Aggregate rule which evaluates whether the column aggregate
 statistic lies between a specified range.
      .google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation statistic_range_expectation = 101;
      Returns:
      The statisticRangeExpectation.

    • getStatisticRangeExpectationOrBuilder

      DataQualityRule.StatisticRangeExpectationOrBuilder getStatisticRangeExpectationOrBuilder()
       Aggregate rule which evaluates whether the column aggregate
 statistic lies between a specified range.
      .google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation statistic_range_expectation = 101;

    • hasRowConditionExpectation

      boolean hasRowConditionExpectation()
       Row-level rule which evaluates whether each row in a table passes the
 specified condition.
      .google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation row_condition_expectation = 200;
      Returns:
      Whether the rowConditionExpectation field is set.

    • getRowConditionExpectation

      DataQualityRule.RowConditionExpectation getRowConditionExpectation()
       Row-level rule which evaluates whether each row in a table passes the
 specified condition.
      .google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation row_condition_expectation = 200;
      Returns:
      The rowConditionExpectation.

    • getRowConditionExpectationOrBuilder

      DataQualityRule.RowConditionExpectationOrBuilder getRowConditionExpectationOrBuilder()
       Row-level rule which evaluates whether each row in a table passes the
 specified condition.
      .google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation row_condition_expectation = 200;

    • hasTableConditionExpectation

      boolean hasTableConditionExpectation()
       Aggregate rule which evaluates whether the provided expression is true
 for a table.
      .google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation table_condition_expectation = 201;
      Returns:
      Whether the tableConditionExpectation field is set.

    • getTableConditionExpectation

      DataQualityRule.TableConditionExpectation getTableConditionExpectation()
       Aggregate rule which evaluates whether the provided expression is true
 for a table.
      .google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation table_condition_expectation = 201;
      Returns:
      The tableConditionExpectation.

    • getTableConditionExpectationOrBuilder

      DataQualityRule.TableConditionExpectationOrBuilder getTableConditionExpectationOrBuilder()
       Aggregate rule which evaluates whether the provided expression is true
 for a table.
      .google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation table_condition_expectation = 201;

    • hasSqlAssertion

      boolean hasSqlAssertion()
       Aggregate rule which evaluates the number of rows returned for the
 provided statement. If any rows are returned, this rule fails.
      .google.cloud.dataplex.v1.DataQualityRule.SqlAssertion sql_assertion = 202;
      Returns:
      Whether the sqlAssertion field is set.

    • getSqlAssertion

      DataQualityRule.SqlAssertion getSqlAssertion()
       Aggregate rule which evaluates the number of rows returned for the
 provided statement. If any rows are returned, this rule fails.
      .google.cloud.dataplex.v1.DataQualityRule.SqlAssertion sql_assertion = 202;
      Returns:
      The sqlAssertion.

    • getSqlAssertionOrBuilder

      DataQualityRule.SqlAssertionOrBuilder getSqlAssertionOrBuilder()
       Aggregate rule which evaluates the number of rows returned for the
 provided statement. If any rows are returned, this rule fails.
      .google.cloud.dataplex.v1.DataQualityRule.SqlAssertion sql_assertion = 202;

    • getColumn

      String getColumn()
       Optional. The unnested column which this rule is evaluated against.
      string column = 500 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The column.

    • getColumnBytes

      com.google.protobuf.ByteString getColumnBytes()
       Optional. The unnested column which this rule is evaluated against.
      string column = 500 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for column.

    • getIgnoreNull

      boolean getIgnoreNull()
       Optional. Rows with `null` values will automatically fail a rule, unless
 `ignore_null` is `true`. In that case, such `null` rows are trivially
 considered passing.

 This field is only valid for the following type of rules:

 * RangeExpectation
 * RegexExpectation
 * SetExpectation
 * UniquenessExpectation
      bool ignore_null = 501 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The ignoreNull.

    • getDimension

      String getDimension()
       Optional. The dimension a rule belongs to. Results are also aggregated at
 the dimension level. Custom dimension name is supported with all uppercase
 letters and maximum length of 30 characters.
      string dimension = 502 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The dimension.

    • getDimensionBytes

      com.google.protobuf.ByteString getDimensionBytes()
       Optional. The dimension a rule belongs to. Results are also aggregated at
 the dimension level. Custom dimension name is supported with all uppercase
 letters and maximum length of 30 characters.
      string dimension = 502 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for dimension.

    • getThreshold

      double getThreshold()
       Optional. The minimum ratio of **passing_rows / total_rows** required to
 pass this rule, with a range of [0.0, 1.0].

 0 indicates default value (i.e. 1.0).

 This field is only valid for row-level type rules.
      double threshold = 503 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The threshold.

    • getName

      String getName()
       Optional. A mutable name for the rule.

 * The name must contain only letters (a-z, A-Z), numbers (0-9), or
 hyphens (-).
 * The maximum length is 63 characters.
 * Must start with a letter.
 * Must end with a number or a letter.
      string name = 504 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Optional. A mutable name for the rule.

 * The name must contain only letters (a-z, A-Z), numbers (0-9), or
 hyphens (-).
 * The maximum length is 63 characters.
 * Must start with a letter.
 * Must end with a number or a letter.
      string name = 504 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for name.

    • getDescription

      String getDescription()
       Optional. Description of the rule.

 * The maximum length is 1,024 characters.
      string description = 505 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description of the rule.

 * The maximum length is 1,024 characters.
      string description = 505 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.

    • getSuspended

      boolean getSuspended()
       Optional. Whether the Rule is active or suspended.
 Default is false.
      bool suspended = 506 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The suspended.

    • getDebugQueriesList

      List<DataQualityRule.DebugQuery> getDebugQueriesList()
       Optional. Specifies the debug queries for this rule.
 Currently, only one query is supported, but this may be expanded in the
 future.
      repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

    • getDebugQueries

      DataQualityRule.DebugQuery getDebugQueries(int index)
       Optional. Specifies the debug queries for this rule.
 Currently, only one query is supported, but this may be expanded in the
 future.
      repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

    • getDebugQueriesCount

      int getDebugQueriesCount()
       Optional. Specifies the debug queries for this rule.
 Currently, only one query is supported, but this may be expanded in the
 future.
      repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

    • getDebugQueriesOrBuilderList

      List<? extends DataQualityRule.DebugQueryOrBuilder> getDebugQueriesOrBuilderList()
       Optional. Specifies the debug queries for this rule.
 Currently, only one query is supported, but this may be expanded in the
 future.
      repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

    • getDebugQueriesOrBuilder

      DataQualityRule.DebugQueryOrBuilder getDebugQueriesOrBuilder(int index)
       Optional. Specifies the debug queries for this rule.
 Currently, only one query is supported, but this may be expanded in the
 future.
      repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

    • getRuleTypeCase

      DataQualityRule.RuleTypeCase getRuleTypeCase()