Interface Rule.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Rule.Builder,Rule>, SdkBuilder<Rule.Builder,Rule>, SdkPojo
Enclosing class:
Rule
@Mutable @NotThreadSafe public static interface Rule.Builder extends SdkPojo, CopyableBuilder<Rule.Builder,Rule>

  • Method Details

    • name

      Rule.Builder name(String name)

      The name of the rule.

      Parameters:
      name - The name of the rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disabled

      Rule.Builder disabled(Boolean disabled)

      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.

      Parameters:
      disabled - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checkExpression

      Rule.Builder checkExpression(String checkExpression)

      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 column reference in the left side of a condition, for example, is_between :val1 and :val2.

      For more information, see Available checks

      Parameters:
      checkExpression - 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 column reference in the left side of a condition, for example, is_between :val1 and :val2.

      For more information, see Available checks

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • substitutionMap

      Rule.Builder substitutionMap(Map<String,String> substitutionMap)

      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`".

      Parameters:
      substitutionMap - 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`".
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • threshold

      Rule.Builder threshold(Threshold threshold)

      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.

      Parameters:
      threshold - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • threshold

      default Rule.Builder threshold(Consumer<Threshold.Builder> threshold)

      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.

      This is a convenience method that creates an instance of the Threshold.Builder avoiding the need to create one manually via Threshold.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to threshold(Threshold).

      Parameters:
      threshold - a consumer that will call methods on Threshold.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • columnSelectors

      Rule.Builder columnSelectors(Collection<ColumnSelector> columnSelectors)

      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.

      Parameters:
      columnSelectors - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • columnSelectors

      Rule.Builder columnSelectors(ColumnSelector... columnSelectors)

      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.

      Parameters:
      columnSelectors - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • columnSelectors

      Rule.Builder columnSelectors(Consumer<ColumnSelector.Builder>... columnSelectors)

      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.

      This is a convenience method that creates an instance of the ColumnSelector.Builder avoiding the need to create one manually via ColumnSelector.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to columnSelectors(List<ColumnSelector>).

      Parameters:
      columnSelectors - a consumer that will call methods on ColumnSelector.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: