Interface CfnRuleset.RuleProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnRuleset.RuleProperty extends
Represents a single data quality requirement that should be validated in the scope of this dataset.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 RuleProperty ruleProperty = RuleProperty.builder()
         // the properties below are optional
                 // the properties below are optional
  • Method Details

    • getCheckExpression

      @Stability(Stable) @NotNull String getCheckExpression()
      The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions.

      For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2) . Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no columnn reference in the left side of a condition, for example, is_between :val1 and :val2 .

    • getName

      @Stability(Stable) @NotNull String getName()
      The name of the rule.
    • getColumnSelectors

      @Stability(Stable) @Nullable default Object getColumnSelectors()
      List of column selectors.

      Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.

    • getDisabled

      @Stability(Stable) @Nullable default Object getDisabled()
      A value that specifies whether the rule is disabled.

      Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.

    • getSubstitutionMap

      @Stability(Stable) @Nullable default Object getSubstitutionMap()
      The map of substitution variable names to their values used in a check expression.

      Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, ":col1": "Column A".

    • getThreshold

      @Stability(Stable) @Nullable default Object getThreshold()
      The threshold used with a non-aggregate check expression.

      Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.

    • builder

      @Stability(Stable) static CfnRuleset.RuleProperty.Builder builder()
      a CfnRuleset.RuleProperty.Builder of CfnRuleset.RuleProperty