Interface CfnRuleset.RuleProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnRuleset.RuleProperty.Jsii$Proxy
- Enclosing class:
CfnRuleset
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();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnRuleset.RuleProperty
static final class
An implementation forCfnRuleset.RuleProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions.default Object
List of column selectors.default Object
A value that specifies whether the rule is disabled.getName()
The name of the rule.default Object
The map of substitution variable names to their values used in a check expression.default Object
The threshold used with a non-aggregate check expression.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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
.- See Also:
-
getName
The name of the rule.- See Also:
-
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.
- See Also:
-
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.
- See Also:
-
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".
- See Also:
-
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.
- See Also:
-
builder
- Returns:
- a
CfnRuleset.RuleProperty.Builder
ofCfnRuleset.RuleProperty
-