- 1.53.0 (latest)
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.2
- 1.0.1
- 0.2.2
public interface DataQualityRuleOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getColumn()
public abstract String getColumn()Optional. The unnested column which this rule is evaluated against.
string column = 500 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The column. |
getColumnBytes()
public abstract ByteString getColumnBytes()Optional. The unnested column which this rule is evaluated against.
string column = 500 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for column. |
getDescription()
public abstract String getDescription()Optional. Description of the rule.
- The maximum length is 1,024 characters.
string description = 505 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()Optional. Description of the rule.
- The maximum length is 1,024 characters.
string description = 505 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDimension()
public abstract String getDimension()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 dimension = 502 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The dimension. |
getDimensionBytes()
public abstract ByteString getDimensionBytes()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 dimension = 502 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for dimension. |
getIgnoreNull()
public abstract boolean getIgnoreNull() 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
bool ignore_null = 501 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The ignoreNull. |
getName()
public abstract String getName()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 name = 504 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes()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 name = 504 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getNonNullExpectation()
public abstract DataQualityRule.NonNullExpectation getNonNullExpectation()Row-level rule which evaluates whether each column value is null.
.google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation non_null_expectation = 2;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.NonNullExpectation |
The nonNullExpectation. |
getNonNullExpectationOrBuilder()
public abstract DataQualityRule.NonNullExpectationOrBuilder getNonNullExpectationOrBuilder()Row-level rule which evaluates whether each column value is null.
.google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation non_null_expectation = 2;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.NonNullExpectationOrBuilder |
|
getRangeExpectation()
public abstract DataQualityRule.RangeExpectation getRangeExpectation()Row-level rule which evaluates whether each column value lies between a specified range.
.google.cloud.dataplex.v1.DataQualityRule.RangeExpectation range_expectation = 1;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.RangeExpectation |
The rangeExpectation. |
getRangeExpectationOrBuilder()
public abstract DataQualityRule.RangeExpectationOrBuilder getRangeExpectationOrBuilder()Row-level rule which evaluates whether each column value lies between a specified range.
.google.cloud.dataplex.v1.DataQualityRule.RangeExpectation range_expectation = 1;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.RangeExpectationOrBuilder |
|
getRegexExpectation()
public abstract DataQualityRule.RegexExpectation getRegexExpectation()Row-level rule which evaluates whether each column value matches a specified regex.
.google.cloud.dataplex.v1.DataQualityRule.RegexExpectation regex_expectation = 4;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.RegexExpectation |
The regexExpectation. |
getRegexExpectationOrBuilder()
public abstract DataQualityRule.RegexExpectationOrBuilder getRegexExpectationOrBuilder()Row-level rule which evaluates whether each column value matches a specified regex.
.google.cloud.dataplex.v1.DataQualityRule.RegexExpectation regex_expectation = 4;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.RegexExpectationOrBuilder |
|
getRowConditionExpectation()
public abstract DataQualityRule.RowConditionExpectation getRowConditionExpectation()Row-level rule which evaluates whether each row in a table passes the specified condition.
.google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation row_condition_expectation = 200;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.RowConditionExpectation |
The rowConditionExpectation. |
getRowConditionExpectationOrBuilder()
public abstract DataQualityRule.RowConditionExpectationOrBuilder getRowConditionExpectationOrBuilder()Row-level rule which evaluates whether each row in a table passes the specified condition.
.google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation row_condition_expectation = 200;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.RowConditionExpectationOrBuilder |
|
getRuleTypeCase()
public abstract DataQualityRule.RuleTypeCase getRuleTypeCase()| Returns | |
|---|---|
| Type | Description |
DataQualityRule.RuleTypeCase |
|
getSetExpectation()
public abstract DataQualityRule.SetExpectation getSetExpectation()Row-level rule which evaluates whether each column value is contained by a specified set.
.google.cloud.dataplex.v1.DataQualityRule.SetExpectation set_expectation = 3;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.SetExpectation |
The setExpectation. |
getSetExpectationOrBuilder()
public abstract DataQualityRule.SetExpectationOrBuilder getSetExpectationOrBuilder()Row-level rule which evaluates whether each column value is contained by a specified set.
.google.cloud.dataplex.v1.DataQualityRule.SetExpectation set_expectation = 3;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.SetExpectationOrBuilder |
|
getSqlAssertion()
public abstract DataQualityRule.SqlAssertion getSqlAssertion()Aggregate rule which evaluates the number of rows returned for the provided statement. If any rows are returned, this rule fails.
.google.cloud.dataplex.v1.DataQualityRule.SqlAssertion sql_assertion = 202;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.SqlAssertion |
The sqlAssertion. |
getSqlAssertionOrBuilder()
public abstract DataQualityRule.SqlAssertionOrBuilder getSqlAssertionOrBuilder()Aggregate rule which evaluates the number of rows returned for the provided statement. If any rows are returned, this rule fails.
.google.cloud.dataplex.v1.DataQualityRule.SqlAssertion sql_assertion = 202;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.SqlAssertionOrBuilder |
|
getStatisticRangeExpectation()
public abstract DataQualityRule.StatisticRangeExpectation getStatisticRangeExpectation()Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
.google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation statistic_range_expectation = 101;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.StatisticRangeExpectation |
The statisticRangeExpectation. |
getStatisticRangeExpectationOrBuilder()
public abstract DataQualityRule.StatisticRangeExpectationOrBuilder getStatisticRangeExpectationOrBuilder()Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
.google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation statistic_range_expectation = 101;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.StatisticRangeExpectationOrBuilder |
|
getTableConditionExpectation()
public abstract DataQualityRule.TableConditionExpectation getTableConditionExpectation()Aggregate rule which evaluates whether the provided expression is true for a table.
.google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation table_condition_expectation = 201;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.TableConditionExpectation |
The tableConditionExpectation. |
getTableConditionExpectationOrBuilder()
public abstract DataQualityRule.TableConditionExpectationOrBuilder getTableConditionExpectationOrBuilder()Aggregate rule which evaluates whether the provided expression is true for a table.
.google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation table_condition_expectation = 201;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.TableConditionExpectationOrBuilder |
|
getThreshold()
public abstract double getThreshold()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.
double threshold = 503 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
double |
The threshold. |
getUniquenessExpectation()
public abstract DataQualityRule.UniquenessExpectation getUniquenessExpectation()Row-level rule which evaluates whether each column value is unique.
.google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.UniquenessExpectation |
The uniquenessExpectation. |
getUniquenessExpectationOrBuilder()
public abstract DataQualityRule.UniquenessExpectationOrBuilder getUniquenessExpectationOrBuilder()Row-level rule which evaluates whether each column value is unique.
.google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;
| Returns | |
|---|---|
| Type | Description |
DataQualityRule.UniquenessExpectationOrBuilder |
|
hasNonNullExpectation()
public abstract boolean hasNonNullExpectation()Row-level rule which evaluates whether each column value is null.
.google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation non_null_expectation = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the nonNullExpectation field is set. |
hasRangeExpectation()
public abstract boolean hasRangeExpectation()Row-level rule which evaluates whether each column value lies between a specified range.
.google.cloud.dataplex.v1.DataQualityRule.RangeExpectation range_expectation = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the rangeExpectation field is set. |
hasRegexExpectation()
public abstract boolean hasRegexExpectation()Row-level rule which evaluates whether each column value matches a specified regex.
.google.cloud.dataplex.v1.DataQualityRule.RegexExpectation regex_expectation = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the regexExpectation field is set. |
hasRowConditionExpectation()
public abstract boolean hasRowConditionExpectation()Row-level rule which evaluates whether each row in a table passes the specified condition.
.google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation row_condition_expectation = 200;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the rowConditionExpectation field is set. |
hasSetExpectation()
public abstract boolean hasSetExpectation()Row-level rule which evaluates whether each column value is contained by a specified set.
.google.cloud.dataplex.v1.DataQualityRule.SetExpectation set_expectation = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the setExpectation field is set. |
hasSqlAssertion()
public abstract boolean hasSqlAssertion()Aggregate rule which evaluates the number of rows returned for the provided statement. If any rows are returned, this rule fails.
.google.cloud.dataplex.v1.DataQualityRule.SqlAssertion sql_assertion = 202;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the sqlAssertion field is set. |
hasStatisticRangeExpectation()
public abstract boolean hasStatisticRangeExpectation()Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
.google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation statistic_range_expectation = 101;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the statisticRangeExpectation field is set. |
hasTableConditionExpectation()
public abstract boolean hasTableConditionExpectation()Aggregate rule which evaluates whether the provided expression is true for a table.
.google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation table_condition_expectation = 201;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the tableConditionExpectation field is set. |
hasUniquenessExpectation()
public abstract boolean hasUniquenessExpectation()Row-level rule which evaluates whether each column value is unique.
.google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the uniquenessExpectation field is set. |