GetDataQualityRulesRule class
Constructors
-
GetDataQualityRulesRule({required Input<String> column, required Input<String> description, required Input<String> dimension, required Input<bool> ignoreNull, required Input<String> name, required Input<List<Map<String, dynamic>>> nonNullExpectations, required Input<List<GetDataQualityRulesRuleRangeExpectation>> rangeExpectations, required Input<List<GetDataQualityRulesRuleRegexExpectation>> regexExpectations, required Input<List<GetDataQualityRulesRuleRowConditionExpectation>> rowConditionExpectations, required Input<List<GetDataQualityRulesRuleSetExpectation>> setExpectations, required Input<List<GetDataQualityRulesRuleSqlAssertion>> sqlAssertions, required Input<List<GetDataQualityRulesRuleStatisticRangeExpectation>> statisticRangeExpectations, required Input<bool> suspended, required Input<List<GetDataQualityRulesRuleTableConditionExpectation>> tableConditionExpectations, required Input<double> threshold, required Input<List<Map<String, dynamic>>> uniquenessExpectations})
-
Creates a new GetDataQualityRulesRule.
column The unnested column which this rule is evaluated against.
description Description of the rule. (The maximum length is 1,024 characters.)
dimension The dimension a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME"
ignoreNull Rows with null values will automatically fail a rule, unless ignoreNull is true. In that case, such null rows are trivially considered passing.
name A mutable name for the rule.
nonNullExpectations Row-level rule which evaluates whether each column value is null.
rangeExpectations Row-level rule which evaluates whether each column value lies between a specified range.
regexExpectations Row-level rule which evaluates whether each column value matches a specified regex.
rowConditionExpectations Row-level rule which evaluates whether each row in a table passes the specified condition.
setExpectations Row-level rule which evaluates whether each column value is contained by a specified set.
sqlAssertions Aggregate rule which evaluates the number of rows returned for the provided statement. If any rows are returned, this rule fails.
statisticRangeExpectations Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
suspended Whether the Rule is active or suspended. Default is false.
tableConditionExpectations Aggregate rule which evaluates whether the provided expression is true for a table.
threshold The minimum ratio of passingRows / totalRows required to pass this rule, with a range of 0.0, 1.0. 0 indicates default value (i.e. 1.0). This field is only valid for row-level type rules.
uniquenessExpectations Row-level rule which evaluates whether each column value is unique.
const
-
GetDataQualityRulesRule.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
column
→ Input<String>
-
The unnested column which this rule is evaluated against.
final
-
description
→ Input<String>
-
Description of the rule. (The maximum length is 1,024 characters.)
final
-
dimension
→ Input<String>
-
The dimension a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME"
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
ignoreNull
→ Input<bool>
-
Rows with null values will automatically fail a rule, unless ignoreNull is true. In that case, such null rows are trivially considered passing.
This field is only valid for the following type of rules: RangeExpectation, RegexExpectation, SetExpectation, UniquenessExpectation
final
-
name
→ Input<String>
-
A mutable name for the rule.
The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-).
The maximum length is 63 characters.
Must start with a letter.
Must end with a number or a letter.
final
-
nonNullExpectations
→ Input<List<Map<String, dynamic>>>
-
Row-level rule which evaluates whether each column value is null.
final
-
rangeExpectations
→ Input<List<GetDataQualityRulesRuleRangeExpectation>>
-
Row-level rule which evaluates whether each column value lies between a specified range.
final
-
regexExpectations
→ Input<List<GetDataQualityRulesRuleRegexExpectation>>
-
Row-level rule which evaluates whether each column value matches a specified regex.
final
-
rowConditionExpectations
→ Input<List<GetDataQualityRulesRuleRowConditionExpectation>>
-
Row-level rule which evaluates whether each row in a table passes the specified condition.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
setExpectations
→ Input<List<GetDataQualityRulesRuleSetExpectation>>
-
Row-level rule which evaluates whether each column value is contained by a specified set.
final
-
sqlAssertions
→ Input<List<GetDataQualityRulesRuleSqlAssertion>>
-
Aggregate rule which evaluates the number of rows returned for the provided statement. If any rows are returned, this rule fails.
final
-
statisticRangeExpectations
→ Input<List<GetDataQualityRulesRuleStatisticRangeExpectation>>
-
Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
final
-
suspended
→ Input<bool>
-
Whether the Rule is active or suspended. Default is false.
final
-
tableConditionExpectations
→ Input<List<GetDataQualityRulesRuleTableConditionExpectation>>
-
Aggregate rule which evaluates whether the provided expression is true for a table.
final
-
threshold
→ Input<double>
-
The minimum ratio of passingRows / totalRows required to pass this rule, with a range of
0.0, 1.0. 0 indicates default value (i.e. 1.0). This field is only valid for row-level type rules.
final
-
uniquenessExpectations
→ Input<List<Map<String, dynamic>>>
-
Row-level rule which evaluates whether each column value is unique.
final
