RulesetRuleArgs

data class RulesetRuleArgs(val checkExpression: Output<String>, val columnSelectors: Output<List<RulesetColumnSelectorArgs>>? = null, val disabled: Output<Boolean>? = null, val name: Output<String>, val substitutionMap: Output<List<RulesetSubstitutionValueArgs>>? = null, val threshold: Output<RulesetThresholdArgs>? = null) : ConvertibleToJava<RulesetRuleArgs>

Data quality rule for a target resource (dataset)

Constructors

Link copied to clipboard
constructor(checkExpression: Output<String>, columnSelectors: Output<List<RulesetColumnSelectorArgs>>? = null, disabled: Output<Boolean>? = null, name: Output<String>, substitutionMap: Output<List<RulesetSubstitutionValueArgs>>? = null, threshold: Output<RulesetThresholdArgs>? = null)

Properties

Link copied to clipboard
val checkExpression: Output<String>

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 .

Link copied to clipboard

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.

Link copied to clipboard
val disabled: Output<Boolean>? = null

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.

Link copied to clipboard
val name: Output<String>

Name of the rule

Link copied to clipboard

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

Link copied to clipboard
val threshold: Output<RulesetThresholdArgs>? = null

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.

Functions

Link copied to clipboard
open override fun toJava(): RulesetRuleArgs