Cloud Dataplex v1 API - Class DataQualityRule (3.3.0) 

public sealed class DataQualityRule : IMessage<DataQualityRule>, IEquatable<DataQualityRule>, IDeepCloneable<DataQualityRule>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Dataplex v1 API class DataQualityRule.

A rule captures data quality intent about a data source.

Inheritance

object > DataQualityRule

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

DataQualityRule()

public DataQualityRule()

DataQualityRule(DataQualityRule)

public DataQualityRule(DataQualityRule other)
Parameter
Name Description
other DataQualityRule

Properties

Column

public string Column { get; set; }

Optional. The unnested column which this rule is evaluated against.

Property Value
Type Description
string

Description

public string Description { get; set; }

Optional. Description of the rule.

  • The maximum length is 1,024 characters.
Property Value
Type Description
string

Dimension

public string Dimension { get; set; }

Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]

Property Value
Type Description
string

IgnoreNull

public bool IgnoreNull { get; set; }

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
Property Value
Type Description
bool

Name

public string Name { get; set; }

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.
Property Value
Type Description
string

NonNullExpectation

public DataQualityRule.Types.NonNullExpectation NonNullExpectation { get; set; }

Row-level rule which evaluates whether each column value is null.

Property Value
Type Description
DataQualityRuleTypesNonNullExpectation

RangeExpectation

public DataQualityRule.Types.RangeExpectation RangeExpectation { get; set; }

Row-level rule which evaluates whether each column value lies between a specified range.

Property Value
Type Description
DataQualityRuleTypesRangeExpectation

RegexExpectation

public DataQualityRule.Types.RegexExpectation RegexExpectation { get; set; }

Row-level rule which evaluates whether each column value matches a specified regex.

Property Value
Type Description
DataQualityRuleTypesRegexExpectation

RowConditionExpectation

public DataQualityRule.Types.RowConditionExpectation RowConditionExpectation { get; set; }

Row-level rule which evaluates whether each row in a table passes the specified condition.

Property Value
Type Description
DataQualityRuleTypesRowConditionExpectation

RuleTypeCase

public DataQualityRule.RuleTypeOneofCase RuleTypeCase { get; }
Property Value
Type Description
DataQualityRuleRuleTypeOneofCase

SetExpectation

public DataQualityRule.Types.SetExpectation SetExpectation { get; set; }

Row-level rule which evaluates whether each column value is contained by a specified set.

Property Value
Type Description
DataQualityRuleTypesSetExpectation

SqlAssertion

public DataQualityRule.Types.SqlAssertion SqlAssertion { get; set; }

Aggregate rule which evaluates the number of rows returned for the provided statement. If any rows are returned, this rule fails.

Property Value
Type Description
DataQualityRuleTypesSqlAssertion

StatisticRangeExpectation

public DataQualityRule.Types.StatisticRangeExpectation StatisticRangeExpectation { get; set; }

Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range.

Property Value
Type Description
DataQualityRuleTypesStatisticRangeExpectation

TableConditionExpectation

public DataQualityRule.Types.TableConditionExpectation TableConditionExpectation { get; set; }

Aggregate rule which evaluates whether the provided expression is true for a table.

Property Value
Type Description
DataQualityRuleTypesTableConditionExpectation

Threshold

public double Threshold { get; set; }

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.

Property Value
Type Description
double

UniquenessExpectation

public DataQualityRule.Types.UniquenessExpectation UniquenessExpectation { get; set; }

Row-level rule which evaluates whether each column value is unique.

Property Value
Type Description
DataQualityRuleTypesUniquenessExpectation