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
Static Fields
COLUMN_FIELD_NUMBER
public static final int COLUMN_FIELD_NUMBER
Field Value
DIMENSION_FIELD_NUMBER
public static final int DIMENSION_FIELD_NUMBER
Field Value
IGNORE_NULL_FIELD_NUMBER
public static final int IGNORE_NULL_FIELD_NUMBER
Field Value
NON_NULL_EXPECTATION_FIELD_NUMBER
public static final int NON_NULL_EXPECTATION_FIELD_NUMBER
Field Value
RANGE_EXPECTATION_FIELD_NUMBER
public static final int RANGE_EXPECTATION_FIELD_NUMBER
Field Value
REGEX_EXPECTATION_FIELD_NUMBER
public static final int REGEX_EXPECTATION_FIELD_NUMBER
Field Value
ROW_CONDITION_EXPECTATION_FIELD_NUMBER
public static final int ROW_CONDITION_EXPECTATION_FIELD_NUMBER
Field Value
SET_EXPECTATION_FIELD_NUMBER
public static final int SET_EXPECTATION_FIELD_NUMBER
Field Value
STATISTIC_RANGE_EXPECTATION_FIELD_NUMBER
public static final int STATISTIC_RANGE_EXPECTATION_FIELD_NUMBER
Field Value
TABLE_CONDITION_EXPECTATION_FIELD_NUMBER
public static final int TABLE_CONDITION_EXPECTATION_FIELD_NUMBER
Field Value
THRESHOLD_FIELD_NUMBER
public static final int THRESHOLD_FIELD_NUMBER
Field Value
UNIQUENESS_EXPECTATION_FIELD_NUMBER
public static final int UNIQUENESS_EXPECTATION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static DataQualityRule getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static DataQualityRule.Builder newBuilder()
Returns
newBuilder(DataQualityRule prototype)
public static DataQualityRule.Builder newBuilder(DataQualityRule prototype)
Parameter
Returns
public static DataQualityRule parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DataQualityRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DataQualityRule parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DataQualityRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DataQualityRule parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataQualityRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DataQualityRule parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DataQualityRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DataQualityRule parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DataQualityRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DataQualityRule parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DataQualityRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<DataQualityRule> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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
getDefaultInstanceForType()
public DataQualityRule getDefaultInstanceForType()
Returns
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", "INTEGRITY"]
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", "INTEGRITY"]
string dimension = 502 [(.google.api.field_behavior) = REQUIRED];
Returns
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. Only applicable to ColumnMap rules.
bool ignore_null = 501 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type | Description |
boolean | The ignoreNull.
|
getNonNullExpectation()
public DataQualityRule.NonNullExpectation getNonNullExpectation()
ColumnMap rule which evaluates whether each column value is null.
.google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation non_null_expectation = 2;
Returns
getNonNullExpectationOrBuilder()
public DataQualityRule.NonNullExpectationOrBuilder getNonNullExpectationOrBuilder()
ColumnMap rule which evaluates whether each column value is null.
.google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation non_null_expectation = 2;
Returns
getParserForType()
public Parser<DataQualityRule> getParserForType()
Returns
Overrides
getRangeExpectation()
public DataQualityRule.RangeExpectation getRangeExpectation()
ColumnMap rule which evaluates whether each column value lies between a
specified range.
.google.cloud.dataplex.v1.DataQualityRule.RangeExpectation range_expectation = 1;
Returns
getRangeExpectationOrBuilder()
public DataQualityRule.RangeExpectationOrBuilder getRangeExpectationOrBuilder()
ColumnMap rule which evaluates whether each column value lies between a
specified range.
.google.cloud.dataplex.v1.DataQualityRule.RangeExpectation range_expectation = 1;
Returns
getRegexExpectation()
public DataQualityRule.RegexExpectation getRegexExpectation()
ColumnMap rule which evaluates whether each column value matches a
specified regex.
.google.cloud.dataplex.v1.DataQualityRule.RegexExpectation regex_expectation = 4;
Returns
getRegexExpectationOrBuilder()
public DataQualityRule.RegexExpectationOrBuilder getRegexExpectationOrBuilder()
ColumnMap rule which evaluates whether each column value matches a
specified regex.
.google.cloud.dataplex.v1.DataQualityRule.RegexExpectation regex_expectation = 4;
Returns
getRowConditionExpectation()
public DataQualityRule.RowConditionExpectation getRowConditionExpectation()
Table rule which evaluates whether each row passes the specified
condition.
.google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation row_condition_expectation = 200;
Returns
getRowConditionExpectationOrBuilder()
public DataQualityRule.RowConditionExpectationOrBuilder getRowConditionExpectationOrBuilder()
Table rule which evaluates whether each row passes the specified
condition.
.google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation row_condition_expectation = 200;
Returns
getRuleTypeCase()
public DataQualityRule.RuleTypeCase getRuleTypeCase()
Returns
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSetExpectation()
public DataQualityRule.SetExpectation getSetExpectation()
ColumnMap rule which evaluates whether each column value is contained by
a specified set.
.google.cloud.dataplex.v1.DataQualityRule.SetExpectation set_expectation = 3;
Returns
getSetExpectationOrBuilder()
public DataQualityRule.SetExpectationOrBuilder getSetExpectationOrBuilder()
ColumnMap rule which evaluates whether each column value is contained by
a specified set.
.google.cloud.dataplex.v1.DataQualityRule.SetExpectation set_expectation = 3;
Returns
getStatisticRangeExpectation()
public DataQualityRule.StatisticRangeExpectation getStatisticRangeExpectation()
ColumnAggregate rule which evaluates whether the column aggregate
statistic lies between a specified range.
.google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation statistic_range_expectation = 101;
Returns
getStatisticRangeExpectationOrBuilder()
public DataQualityRule.StatisticRangeExpectationOrBuilder getStatisticRangeExpectationOrBuilder()
ColumnAggregate rule which evaluates whether the column aggregate
statistic lies between a specified range.
.google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation statistic_range_expectation = 101;
Returns
getTableConditionExpectation()
public DataQualityRule.TableConditionExpectation getTableConditionExpectation()
Table rule which evaluates whether the provided expression is true.
.google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation table_condition_expectation = 201;
Returns
getTableConditionExpectationOrBuilder()
public DataQualityRule.TableConditionExpectationOrBuilder getTableConditionExpectationOrBuilder()
Table rule which evaluates whether the provided expression is true.
.google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation table_condition_expectation = 201;
Returns
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)
double threshold = 503 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type | Description |
double | The threshold.
|
getUniquenessExpectation()
public DataQualityRule.UniquenessExpectation getUniquenessExpectation()
ColumnAggregate rule which evaluates whether the column has duplicates.
.google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;
Returns
getUniquenessExpectationOrBuilder()
public DataQualityRule.UniquenessExpectationOrBuilder getUniquenessExpectationOrBuilder()
ColumnAggregate rule which evaluates whether the column has duplicates.
.google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasNonNullExpectation()
public boolean hasNonNullExpectation()
ColumnMap 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()
ColumnMap 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()
ColumnMap 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()
Table rule which evaluates whether each row 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()
ColumnMap 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.
|
hasStatisticRangeExpectation()
public boolean hasStatisticRangeExpectation()
ColumnAggregate 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()
Table rule which evaluates whether the provided expression is true.
.google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation table_condition_expectation = 201;
Returns
Type | Description |
boolean | Whether the tableConditionExpectation field is set.
|
hasUniquenessExpectation()
public boolean hasUniquenessExpectation()
ColumnAggregate rule which evaluates whether the column has duplicates.
.google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;
Returns
Type | Description |
boolean | Whether the uniquenessExpectation field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public DataQualityRule.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DataQualityRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public DataQualityRule.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions