public static interface CfnRuleset.RuleProperty
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.databrew.*; RuleProperty ruleProperty = RuleProperty.builder() .checkExpression("checkExpression") .name("name") // the properties below are optional .columnSelectors(List.of(ColumnSelectorProperty.builder() .name("name") .regex("regex") .build())) .disabled(false) .substitutionMap(List.of(SubstitutionValueProperty.builder() .value("value") .valueReference("valueReference") .build())) .threshold(ThresholdProperty.builder() .value(123) // the properties below are optional .type("type") .unit("unit") .build()) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnRuleset.RuleProperty.Builder
A builder for
CfnRuleset.RuleProperty |
static class |
CfnRuleset.RuleProperty.Jsii$Proxy
An implementation for
CfnRuleset.RuleProperty |
Modifier and Type | Method and Description |
---|---|
static CfnRuleset.RuleProperty.Builder |
builder() |
java.lang.String |
getCheckExpression()
The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions.
|
default java.lang.Object |
getColumnSelectors()
List of column selectors.
|
default java.lang.Object |
getDisabled()
A value that specifies whether the rule is disabled.
|
java.lang.String |
getName()
The name of the rule.
|
default java.lang.Object |
getSubstitutionMap()
The map of substitution variable names to their values used in a check expression.
|
default java.lang.Object |
getThreshold()
The threshold used with a non-aggregate check expression.
|
java.lang.String getCheckExpression()
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
.
java.lang.String getName()
default java.lang.Object getColumnSelectors()
Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.
default java.lang.Object getDisabled()
Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.
default java.lang.Object getSubstitutionMap()
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".
default java.lang.Object getThreshold()
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.
static CfnRuleset.RuleProperty.Builder builder()
CfnRuleset.RuleProperty.Builder
of CfnRuleset.RuleProperty