Interface Rule.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Rule.Builder,
,Rule> SdkBuilder<Rule.Builder,
,Rule> SdkPojo
- Enclosing class:
Rule
-
Method Summary
Modifier and TypeMethodDescriptioncheckExpression
(String checkExpression) The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions.columnSelectors
(Collection<ColumnSelector> columnSelectors) List of column selectors.columnSelectors
(Consumer<ColumnSelector.Builder>... columnSelectors) List of column selectors.columnSelectors
(ColumnSelector... columnSelectors) List of column selectors.A value that specifies whether the rule is disabled.The name of the rule.substitutionMap
(Map<String, String> substitutionMap) The map of substitution variable names to their values used in a check expression.default Rule.Builder
threshold
(Consumer<Threshold.Builder> threshold) The threshold used with a non-aggregate check expression.The threshold used with a non-aggregate check expression.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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
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
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 theThreshold.Builder
avoiding the need to create one manually viaThreshold.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tothreshold(Threshold)
.- Parameters:
threshold
- a consumer that will call methods onThreshold.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theColumnSelector.Builder
avoiding the need to create one manually viaColumnSelector.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocolumnSelectors(List<ColumnSelector>)
.- Parameters:
columnSelectors
- a consumer that will call methods onColumnSelector.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-