Class CfnRuleset.RuleProperty
Represents a single data quality requirement that should be validated in the scope of this dataset.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.DataBrew
Assembly: Amazon.CDK.AWS.DataBrew.dll
Syntax (csharp)
public class RuleProperty : Object, CfnRuleset.IRulePropertySyntax (vb)
Public Class RuleProperty
Inherits Object
Implements CfnRuleset.IRulePropertyRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DataBrew;
var ruleProperty = new RuleProperty {
CheckExpression = "checkExpression",
Name = "name",
// the properties below are optional
ColumnSelectors = new [] { new ColumnSelectorProperty {
Name = "name",
Regex = "regex"
} },
Disabled = false,
SubstitutionMap = new [] { new SubstitutionValueProperty {
Value = "value",
ValueReference = "valueReference"
} },
Threshold = new ThresholdProperty {
Value = 123,
// the properties below are optional
Type = "type",
Unit = "unit"
}
};Synopsis
Constructors
| RuleProperty() |
Properties
| CheckExpression | The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. |
| ColumnSelectors | List of column selectors. |
| Disabled | A value that specifies whether the rule is disabled. |
| Name | The name of the rule. |
| SubstitutionMap | The map of substitution variable names to their values used in a check expression. |
| Threshold | The threshold used with a non-aggregate check expression. |
Constructors
RuleProperty()
public RuleProperty()Properties
CheckExpression
The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions.
public string CheckExpression { get; set; }Property Value
System.String
Remarks
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 .
ColumnSelectors
List of column selectors.
public object ColumnSelectors { get; set; }Property Value
System.Object
Remarks
Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.
Disabled
A value that specifies whether the rule is disabled.
public object Disabled { get; set; }Property Value
System.Object
Remarks
Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.
Name
The name of the rule.
public string Name { get; set; }Property Value
System.String
Remarks
SubstitutionMap
The map of substitution variable names to their values used in a check expression.
public object SubstitutionMap { get; set; }Property Value
System.Object
Remarks
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".
Threshold
The threshold used with a non-aggregate check expression.
public object Threshold { get; set; }Property Value
System.Object
Remarks
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.