Show / Hide Table of Contents

Class GoogleCloudDataplexV1DataQualityRule

A rule captures data quality intent about a data source.

Inheritance
object
GoogleCloudDataplexV1DataQualityRule
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudDataplex.v1.Data
Assembly: Google.Apis.CloudDataplex.v1.dll
Syntax
public class GoogleCloudDataplexV1DataQualityRule : IDirectResponseSchema

Properties

Column

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

Declaration
[JsonProperty("column")]
public virtual string Column { get; set; }
Property Value
Type Description
string

Description

Optional. Description of the rule. The maximum length is 1,024 characters.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

Dimension

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"

Declaration
[JsonProperty("dimension")]
public virtual string Dimension { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

IgnoreNull

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

Declaration
[JsonProperty("ignoreNull")]
public virtual bool? IgnoreNull { get; set; }
Property Value
Type Description
bool?

Name

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

NonNullExpectation

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

Declaration
[JsonProperty("nonNullExpectation")]
public virtual GoogleCloudDataplexV1DataQualityRuleNonNullExpectation NonNullExpectation { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataQualityRuleNonNullExpectation

RangeExpectation

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

Declaration
[JsonProperty("rangeExpectation")]
public virtual GoogleCloudDataplexV1DataQualityRuleRangeExpectation RangeExpectation { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataQualityRuleRangeExpectation

RegexExpectation

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

Declaration
[JsonProperty("regexExpectation")]
public virtual GoogleCloudDataplexV1DataQualityRuleRegexExpectation RegexExpectation { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataQualityRuleRegexExpectation

RowConditionExpectation

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

Declaration
[JsonProperty("rowConditionExpectation")]
public virtual GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation RowConditionExpectation { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation

SetExpectation

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

Declaration
[JsonProperty("setExpectation")]
public virtual GoogleCloudDataplexV1DataQualityRuleSetExpectation SetExpectation { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataQualityRuleSetExpectation

SqlAssertion

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

Declaration
[JsonProperty("sqlAssertion")]
public virtual GoogleCloudDataplexV1DataQualityRuleSqlAssertion SqlAssertion { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataQualityRuleSqlAssertion

StatisticRangeExpectation

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

Declaration
[JsonProperty("statisticRangeExpectation")]
public virtual GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation StatisticRangeExpectation { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation

Suspended

Optional. Whether the Rule is active or suspended. Default is false.

Declaration
[JsonProperty("suspended")]
public virtual bool? Suspended { get; set; }
Property Value
Type Description
bool?

TableConditionExpectation

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

Declaration
[JsonProperty("tableConditionExpectation")]
public virtual GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation TableConditionExpectation { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation

Threshold

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.

Declaration
[JsonProperty("threshold")]
public virtual double? Threshold { get; set; }
Property Value
Type Description
double?

UniquenessExpectation

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

Declaration
[JsonProperty("uniquenessExpectation")]
public virtual GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation UniquenessExpectation { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX