public final class DataQualityRule extends GeneratedMessageV3 implements DataQualityRuleOrBuilder
A rule captures data quality intent about a data source.
Protobuf type google.cloud.dataplex.v1.DataQualityRule
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
COLUMN_FIELD_NUMBER
public static final int COLUMN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DIMENSION_FIELD_NUMBER
public static final int DIMENSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
IGNORE_NULL_FIELD_NUMBER
public static final int IGNORE_NULL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NON_NULL_EXPECTATION_FIELD_NUMBER
public static final int NON_NULL_EXPECTATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RANGE_EXPECTATION_FIELD_NUMBER
public static final int RANGE_EXPECTATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REGEX_EXPECTATION_FIELD_NUMBER
public static final int REGEX_EXPECTATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ROW_CONDITION_EXPECTATION_FIELD_NUMBER
public static final int ROW_CONDITION_EXPECTATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SET_EXPECTATION_FIELD_NUMBER
public static final int SET_EXPECTATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SQL_ASSERTION_FIELD_NUMBER
public static final int SQL_ASSERTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATISTIC_RANGE_EXPECTATION_FIELD_NUMBER
public static final int STATISTIC_RANGE_EXPECTATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SUSPENDED_FIELD_NUMBER
public static final int SUSPENDED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TABLE_CONDITION_EXPECTATION_FIELD_NUMBER
public static final int TABLE_CONDITION_EXPECTATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
THRESHOLD_FIELD_NUMBER
public static final int THRESHOLD_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UNIQUENESS_EXPECTATION_FIELD_NUMBER
public static final int UNIQUENESS_EXPECTATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static DataQualityRule getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DataQualityRule.Builder newBuilder()
newBuilder(DataQualityRule prototype)
public static DataQualityRule.Builder newBuilder(DataQualityRule prototype)
public static DataQualityRule parseDelimitedFrom(InputStream input)
public static DataQualityRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DataQualityRule parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DataQualityRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DataQualityRule parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataQualityRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataQualityRule parseFrom(CodedInputStream input)
public static DataQualityRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DataQualityRule parseFrom(InputStream input)
public static DataQualityRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DataQualityRule parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DataQualityRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DataQualityRule> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getColumn()
public 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 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.
|
getDefaultInstanceForType()
public DataQualityRule getDefaultInstanceForType()
getDescription()
public 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 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 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", "FRESHNESS",
"VOLUME"]
string dimension = 502 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The dimension.
|
getDimensionBytes()
public 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", "FRESHNESS",
"VOLUME"]
string dimension = 502 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for dimension.
|
getIgnoreNull()
public 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()
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 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 DataQualityRule.NonNullExpectation getNonNullExpectation()
Row-level rule which evaluates whether each column value is null.
.google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation non_null_expectation = 2;
getNonNullExpectationOrBuilder()
public DataQualityRule.NonNullExpectationOrBuilder getNonNullExpectationOrBuilder()
Row-level rule which evaluates whether each column value is null.
.google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation non_null_expectation = 2;
getParserForType()
public Parser<DataQualityRule> getParserForType()
Overrides
getRangeExpectation()
public 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;
getRangeExpectationOrBuilder()
public 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;
getRegexExpectation()
public 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;
getRegexExpectationOrBuilder()
public 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;
getRowConditionExpectation()
public 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;
getRowConditionExpectationOrBuilder()
public 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;
getRuleTypeCase()
public DataQualityRule.RuleTypeCase getRuleTypeCase()
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSetExpectation()
public 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;
getSetExpectationOrBuilder()
public 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;
getSqlAssertion()
public 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;
getSqlAssertionOrBuilder()
public 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;
getStatisticRangeExpectation()
public 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;
getStatisticRangeExpectationOrBuilder()
public 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;
getSuspended()
public boolean getSuspended()
Optional. Whether the Rule is active or suspended.
Default is false.
bool suspended = 506 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The suspended.
|
getTableConditionExpectation()
public 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;
getTableConditionExpectationOrBuilder()
public 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;
getThreshold()
public 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 DataQualityRule.UniquenessExpectation getUniquenessExpectation()
Row-level rule which evaluates whether each column value is unique.
.google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;
getUniquenessExpectationOrBuilder()
public DataQualityRule.UniquenessExpectationOrBuilder getUniquenessExpectationOrBuilder()
Row-level rule which evaluates whether each column value is unique.
.google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;
hasNonNullExpectation()
public 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 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 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 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 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 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 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 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 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DataQualityRule.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DataQualityRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public DataQualityRule.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
