Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::DataQualityRule.
A rule captures data quality intent about a data source.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#column
def column() -> ::String
- (::String) — Optional. The unnested column which this rule is evaluated against.
#column=
def column=(value) -> ::String
- value (::String) — Optional. The unnested column which this rule is evaluated against.
- (::String) — Optional. The unnested column which this rule is evaluated against.
#description
def description() -> ::String
-
(::String) —
Optional. Description of the rule.
- The maximum length is 1,024 characters.
#description=
def description=(value) -> ::String
-
value (::String) —
Optional. Description of the rule.
- The maximum length is 1,024 characters.
-
(::String) —
Optional. Description of the rule.
- The maximum length is 1,024 characters.
#dimension
def dimension() -> ::String
- (::String) — Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]
#dimension=
def dimension=(value) -> ::String
- value (::String) — Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]
- (::String) — Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]
#ignore_null
def ignore_null() -> ::Boolean
-
(::Boolean) — Optional. Rows with
null
values will automatically fail a rule, unlessignore_null
istrue
. In that case, suchnull
rows are trivially considered passing.This field is only valid for row-level type rules.
#ignore_null=
def ignore_null=(value) -> ::Boolean
-
value (::Boolean) — Optional. Rows with
null
values will automatically fail a rule, unlessignore_null
istrue
. In that case, suchnull
rows are trivially considered passing.This field is only valid for row-level type rules.
-
(::Boolean) — Optional. Rows with
null
values will automatically fail a rule, unlessignore_null
istrue
. In that case, suchnull
rows are trivially considered passing.This field is only valid for row-level type rules.
#name
def name() -> ::String
-
(::String) —
Optional. 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.
#name=
def name=(value) -> ::String
-
value (::String) —
Optional. 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.
-
(::String) —
Optional. 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.
#non_null_expectation
def non_null_expectation() -> ::Google::Cloud::Dataplex::V1::DataQualityRule::NonNullExpectation
- (::Google::Cloud::Dataplex::V1::DataQualityRule::NonNullExpectation) — Row-level rule which evaluates whether each column value is null.
#non_null_expectation=
def non_null_expectation=(value) -> ::Google::Cloud::Dataplex::V1::DataQualityRule::NonNullExpectation
- value (::Google::Cloud::Dataplex::V1::DataQualityRule::NonNullExpectation) — Row-level rule which evaluates whether each column value is null.
- (::Google::Cloud::Dataplex::V1::DataQualityRule::NonNullExpectation) — Row-level rule which evaluates whether each column value is null.
#range_expectation
def range_expectation() -> ::Google::Cloud::Dataplex::V1::DataQualityRule::RangeExpectation
- (::Google::Cloud::Dataplex::V1::DataQualityRule::RangeExpectation) — Row-level rule which evaluates whether each column value lies between a specified range.
#range_expectation=
def range_expectation=(value) -> ::Google::Cloud::Dataplex::V1::DataQualityRule::RangeExpectation
- value (::Google::Cloud::Dataplex::V1::DataQualityRule::RangeExpectation) — Row-level rule which evaluates whether each column value lies between a specified range.
- (::Google::Cloud::Dataplex::V1::DataQualityRule::RangeExpectation) — Row-level rule which evaluates whether each column value lies between a specified range.
#regex_expectation
def regex_expectation() -> ::Google::Cloud::Dataplex::V1::DataQualityRule::RegexExpectation
- (::Google::Cloud::Dataplex::V1::DataQualityRule::RegexExpectation) — Row-level rule which evaluates whether each column value matches a specified regex.
#regex_expectation=
def regex_expectation=(value) -> ::Google::Cloud::Dataplex::V1::DataQualityRule::RegexExpectation
- value (::Google::Cloud::Dataplex::V1::DataQualityRule::RegexExpectation) — Row-level rule which evaluates whether each column value matches a specified regex.
- (::Google::Cloud::Dataplex::V1::DataQualityRule::RegexExpectation) — Row-level rule which evaluates whether each column value matches a specified regex.
#row_condition_expectation
def row_condition_expectation() -> ::Google::Cloud::Dataplex::V1::DataQualityRule::RowConditionExpectation
- (::Google::Cloud::Dataplex::V1::DataQualityRule::RowConditionExpectation) — Row-level rule which evaluates whether each row in a table passes the specified condition.
#row_condition_expectation=
def row_condition_expectation=(value) -> ::Google::Cloud::Dataplex::V1::DataQualityRule::RowConditionExpectation
- value (::Google::Cloud::Dataplex::V1::DataQualityRule::RowConditionExpectation) — Row-level rule which evaluates whether each row in a table passes the specified condition.
- (::Google::Cloud::Dataplex::V1::DataQualityRule::RowConditionExpectation) — Row-level rule which evaluates whether each row in a table passes the specified condition.
#set_expectation
def set_expectation() -> ::Google::Cloud::Dataplex::V1::DataQualityRule::SetExpectation
- (::Google::Cloud::Dataplex::V1::DataQualityRule::SetExpectation) — Row-level rule which evaluates whether each column value is contained by a specified set.
#set_expectation=
def set_expectation=(value) -> ::Google::Cloud::Dataplex::V1::DataQualityRule::SetExpectation
- value (::Google::Cloud::Dataplex::V1::DataQualityRule::SetExpectation) — Row-level rule which evaluates whether each column value is contained by a specified set.
- (::Google::Cloud::Dataplex::V1::DataQualityRule::SetExpectation) — Row-level rule which evaluates whether each column value is contained by a specified set.
#statistic_range_expectation
def statistic_range_expectation() -> ::Google::Cloud::Dataplex::V1::DataQualityRule::StatisticRangeExpectation
- (::Google::Cloud::Dataplex::V1::DataQualityRule::StatisticRangeExpectation) — Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
#statistic_range_expectation=
def statistic_range_expectation=(value) -> ::Google::Cloud::Dataplex::V1::DataQualityRule::StatisticRangeExpectation
- value (::Google::Cloud::Dataplex::V1::DataQualityRule::StatisticRangeExpectation) — Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
- (::Google::Cloud::Dataplex::V1::DataQualityRule::StatisticRangeExpectation) — Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
#table_condition_expectation
def table_condition_expectation() -> ::Google::Cloud::Dataplex::V1::DataQualityRule::TableConditionExpectation
- (::Google::Cloud::Dataplex::V1::DataQualityRule::TableConditionExpectation) — Aggregate rule which evaluates whether the provided expression is true for a table.
#table_condition_expectation=
def table_condition_expectation=(value) -> ::Google::Cloud::Dataplex::V1::DataQualityRule::TableConditionExpectation
- value (::Google::Cloud::Dataplex::V1::DataQualityRule::TableConditionExpectation) — Aggregate rule which evaluates whether the provided expression is true for a table.
- (::Google::Cloud::Dataplex::V1::DataQualityRule::TableConditionExpectation) — Aggregate rule which evaluates whether the provided expression is true for a table.
#threshold
def threshold() -> ::Float
-
(::Float) — Optional. The minimum ratio of passing_rows / total_rows 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.
#threshold=
def threshold=(value) -> ::Float
-
value (::Float) — Optional. The minimum ratio of passing_rows / total_rows 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.
-
(::Float) — Optional. The minimum ratio of passing_rows / total_rows 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.
#uniqueness_expectation
def uniqueness_expectation() -> ::Google::Cloud::Dataplex::V1::DataQualityRule::UniquenessExpectation
- (::Google::Cloud::Dataplex::V1::DataQualityRule::UniquenessExpectation) — Row-level rule which evaluates whether each column value is unique.
#uniqueness_expectation=
def uniqueness_expectation=(value) -> ::Google::Cloud::Dataplex::V1::DataQualityRule::UniquenessExpectation
- value (::Google::Cloud::Dataplex::V1::DataQualityRule::UniquenessExpectation) — Row-level rule which evaluates whether each column value is unique.
- (::Google::Cloud::Dataplex::V1::DataQualityRule::UniquenessExpectation) — Row-level rule which evaluates whether each column value is unique.