View Source GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataQualityRule (google_api_dataplex v0.17.0)

A rule captures data quality intent about a data source.

Attributes

  • column (type: String.t, default: nil) - Optional. The unnested column which this rule is evaluated against.
  • description (type: String.t, default: nil) - Optional. Description of the rule. The maximum length is 1,024 characters.
  • dimension (type: String.t, default: nil) - Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", "VOLUME"
  • ignoreNull (type: boolean(), default: nil) - Optional. Rows with null values will automatically fail a rule, unless ignore_null 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
  • name (type: String.t, default: nil) - 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.
  • nonNullExpectation (type: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataQualityRuleNonNullExpectation.t, default: nil) - Row-level rule which evaluates whether each column value is null.
  • rangeExpectation (type: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataQualityRuleRangeExpectation.t, default: nil) - Row-level rule which evaluates whether each column value lies between a specified range.
  • regexExpectation (type: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataQualityRuleRegexExpectation.t, default: nil) - Row-level rule which evaluates whether each column value matches a specified regex.
  • rowConditionExpectation (type: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation.t, default: nil) - Row-level rule which evaluates whether each row in a table passes the specified condition.
  • setExpectation (type: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataQualityRuleSetExpectation.t, default: nil) - Row-level rule which evaluates whether each column value is contained by a specified set.
  • sqlAssertion (type: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataQualityRuleSqlAssertion.t, default: nil) - Aggregate rule which evaluates the number of rows returned for the provided statement. If any rows are returned, this rule fails.
  • statisticRangeExpectation (type: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation.t, default: nil) - Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
  • suspended (type: boolean(), default: nil) - Optional. Whether the Rule is active or suspended. Default is false.
  • tableConditionExpectation (type: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation.t, default: nil) - Aggregate rule which evaluates whether the provided expression is true for a table.
  • threshold (type: float(), default: nil) - 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.
  • uniquenessExpectation (type: GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation.t, default: nil) - Row-level rule which evaluates whether each column value is unique.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.