Class DataQualityRule.Builder (1.12.0)

public static final class DataQualityRule.Builder extends GeneratedMessageV3.Builder<DataQualityRule.Builder> implements DataQualityRuleOrBuilder

A rule captures data quality intent about a data source.

Protobuf type google.cloud.dataplex.v1.DataQualityRule

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DataQualityRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DataQualityRule.Builder
Overrides

build()

public DataQualityRule build()
Returns
TypeDescription
DataQualityRule

buildPartial()

public DataQualityRule buildPartial()
Returns
TypeDescription
DataQualityRule

clear()

public DataQualityRule.Builder clear()
Returns
TypeDescription
DataQualityRule.Builder
Overrides

clearColumn()

public DataQualityRule.Builder clearColumn()

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

string column = 500 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DataQualityRule.Builder

This builder for chaining.

clearDimension()

public DataQualityRule.Builder clearDimension()

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
TypeDescription
DataQualityRule.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DataQualityRule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DataQualityRule.Builder
Overrides

clearIgnoreNull()

public DataQualityRule.Builder clearIgnoreNull()

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
TypeDescription
DataQualityRule.Builder

This builder for chaining.

clearNonNullExpectation()

public DataQualityRule.Builder clearNonNullExpectation()

ColumnMap rule which evaluates whether each column value is null.

.google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation non_null_expectation = 2;

Returns
TypeDescription
DataQualityRule.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public DataQualityRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DataQualityRule.Builder
Overrides

clearRangeExpectation()

public DataQualityRule.Builder clearRangeExpectation()

ColumnMap rule which evaluates whether each column value lies between a specified range.

.google.cloud.dataplex.v1.DataQualityRule.RangeExpectation range_expectation = 1;

Returns
TypeDescription
DataQualityRule.Builder

clearRegexExpectation()

public DataQualityRule.Builder clearRegexExpectation()

ColumnMap rule which evaluates whether each column value matches a specified regex.

.google.cloud.dataplex.v1.DataQualityRule.RegexExpectation regex_expectation = 4;

Returns
TypeDescription
DataQualityRule.Builder

clearRowConditionExpectation()

public DataQualityRule.Builder clearRowConditionExpectation()

Table rule which evaluates whether each row passes the specified condition.

.google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation row_condition_expectation = 200;

Returns
TypeDescription
DataQualityRule.Builder

clearRuleType()

public DataQualityRule.Builder clearRuleType()
Returns
TypeDescription
DataQualityRule.Builder

clearSetExpectation()

public DataQualityRule.Builder clearSetExpectation()

ColumnMap rule which evaluates whether each column value is contained by a specified set.

.google.cloud.dataplex.v1.DataQualityRule.SetExpectation set_expectation = 3;

Returns
TypeDescription
DataQualityRule.Builder

clearStatisticRangeExpectation()

public DataQualityRule.Builder clearStatisticRangeExpectation()

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
TypeDescription
DataQualityRule.Builder

clearTableConditionExpectation()

public DataQualityRule.Builder clearTableConditionExpectation()

Table rule which evaluates whether the provided expression is true.

.google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation table_condition_expectation = 201;

Returns
TypeDescription
DataQualityRule.Builder

clearThreshold()

public DataQualityRule.Builder clearThreshold()

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
TypeDescription
DataQualityRule.Builder

This builder for chaining.

clearUniquenessExpectation()

public DataQualityRule.Builder clearUniquenessExpectation()

ColumnAggregate rule which evaluates whether the column has duplicates.

.google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;

Returns
TypeDescription
DataQualityRule.Builder

clone()

public DataQualityRule.Builder clone()
Returns
TypeDescription
DataQualityRule.Builder
Overrides

getColumn()

public String getColumn()

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

string column = 500 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for column.

getDefaultInstanceForType()

public DataQualityRule getDefaultInstanceForType()
Returns
TypeDescription
DataQualityRule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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. Only applicable to ColumnMap rules.

bool ignore_null = 501 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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
TypeDescription
DataQualityRule.NonNullExpectation

The nonNullExpectation.

getNonNullExpectationBuilder()

public DataQualityRule.NonNullExpectation.Builder getNonNullExpectationBuilder()

ColumnMap rule which evaluates whether each column value is null.

.google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation non_null_expectation = 2;

Returns
TypeDescription
DataQualityRule.NonNullExpectation.Builder

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
TypeDescription
DataQualityRule.NonNullExpectationOrBuilder

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
TypeDescription
DataQualityRule.RangeExpectation

The rangeExpectation.

getRangeExpectationBuilder()

public DataQualityRule.RangeExpectation.Builder getRangeExpectationBuilder()

ColumnMap rule which evaluates whether each column value lies between a specified range.

.google.cloud.dataplex.v1.DataQualityRule.RangeExpectation range_expectation = 1;

Returns
TypeDescription
DataQualityRule.RangeExpectation.Builder

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
TypeDescription
DataQualityRule.RangeExpectationOrBuilder

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
TypeDescription
DataQualityRule.RegexExpectation

The regexExpectation.

getRegexExpectationBuilder()

public DataQualityRule.RegexExpectation.Builder getRegexExpectationBuilder()

ColumnMap rule which evaluates whether each column value matches a specified regex.

.google.cloud.dataplex.v1.DataQualityRule.RegexExpectation regex_expectation = 4;

Returns
TypeDescription
DataQualityRule.RegexExpectation.Builder

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
TypeDescription
DataQualityRule.RegexExpectationOrBuilder

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
TypeDescription
DataQualityRule.RowConditionExpectation

The rowConditionExpectation.

getRowConditionExpectationBuilder()

public DataQualityRule.RowConditionExpectation.Builder getRowConditionExpectationBuilder()

Table rule which evaluates whether each row passes the specified condition.

.google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation row_condition_expectation = 200;

Returns
TypeDescription
DataQualityRule.RowConditionExpectation.Builder

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
TypeDescription
DataQualityRule.RowConditionExpectationOrBuilder

getRuleTypeCase()

public DataQualityRule.RuleTypeCase getRuleTypeCase()
Returns
TypeDescription
DataQualityRule.RuleTypeCase

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
TypeDescription
DataQualityRule.SetExpectation

The setExpectation.

getSetExpectationBuilder()

public DataQualityRule.SetExpectation.Builder getSetExpectationBuilder()

ColumnMap rule which evaluates whether each column value is contained by a specified set.

.google.cloud.dataplex.v1.DataQualityRule.SetExpectation set_expectation = 3;

Returns
TypeDescription
DataQualityRule.SetExpectation.Builder

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
TypeDescription
DataQualityRule.SetExpectationOrBuilder

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
TypeDescription
DataQualityRule.StatisticRangeExpectation

The statisticRangeExpectation.

getStatisticRangeExpectationBuilder()

public DataQualityRule.StatisticRangeExpectation.Builder getStatisticRangeExpectationBuilder()

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
TypeDescription
DataQualityRule.StatisticRangeExpectation.Builder

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
TypeDescription
DataQualityRule.StatisticRangeExpectationOrBuilder

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
TypeDescription
DataQualityRule.TableConditionExpectation

The tableConditionExpectation.

getTableConditionExpectationBuilder()

public DataQualityRule.TableConditionExpectation.Builder getTableConditionExpectationBuilder()

Table rule which evaluates whether the provided expression is true.

.google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation table_condition_expectation = 201;

Returns
TypeDescription
DataQualityRule.TableConditionExpectation.Builder

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
TypeDescription
DataQualityRule.TableConditionExpectationOrBuilder

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
TypeDescription
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
TypeDescription
DataQualityRule.UniquenessExpectation

The uniquenessExpectation.

getUniquenessExpectationBuilder()

public DataQualityRule.UniquenessExpectation.Builder getUniquenessExpectationBuilder()

ColumnAggregate rule which evaluates whether the column has duplicates.

.google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;

Returns
TypeDescription
DataQualityRule.UniquenessExpectation.Builder

getUniquenessExpectationOrBuilder()

public DataQualityRule.UniquenessExpectationOrBuilder getUniquenessExpectationOrBuilder()

ColumnAggregate rule which evaluates whether the column has duplicates.

.google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;

Returns
TypeDescription
DataQualityRule.UniquenessExpectationOrBuilder

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the uniquenessExpectation field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(DataQualityRule other)

public DataQualityRule.Builder mergeFrom(DataQualityRule other)
Parameter
NameDescription
otherDataQualityRule
Returns
TypeDescription
DataQualityRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataQualityRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataQualityRule.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DataQualityRule.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DataQualityRule.Builder
Overrides

mergeNonNullExpectation(DataQualityRule.NonNullExpectation value)

public DataQualityRule.Builder mergeNonNullExpectation(DataQualityRule.NonNullExpectation value)

ColumnMap rule which evaluates whether each column value is null.

.google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation non_null_expectation = 2;

Parameter
NameDescription
valueDataQualityRule.NonNullExpectation
Returns
TypeDescription
DataQualityRule.Builder

mergeRangeExpectation(DataQualityRule.RangeExpectation value)

public DataQualityRule.Builder mergeRangeExpectation(DataQualityRule.RangeExpectation value)

ColumnMap rule which evaluates whether each column value lies between a specified range.

.google.cloud.dataplex.v1.DataQualityRule.RangeExpectation range_expectation = 1;

Parameter
NameDescription
valueDataQualityRule.RangeExpectation
Returns
TypeDescription
DataQualityRule.Builder

mergeRegexExpectation(DataQualityRule.RegexExpectation value)

public DataQualityRule.Builder mergeRegexExpectation(DataQualityRule.RegexExpectation value)

ColumnMap rule which evaluates whether each column value matches a specified regex.

.google.cloud.dataplex.v1.DataQualityRule.RegexExpectation regex_expectation = 4;

Parameter
NameDescription
valueDataQualityRule.RegexExpectation
Returns
TypeDescription
DataQualityRule.Builder

mergeRowConditionExpectation(DataQualityRule.RowConditionExpectation value)

public DataQualityRule.Builder mergeRowConditionExpectation(DataQualityRule.RowConditionExpectation value)

Table rule which evaluates whether each row passes the specified condition.

.google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation row_condition_expectation = 200;

Parameter
NameDescription
valueDataQualityRule.RowConditionExpectation
Returns
TypeDescription
DataQualityRule.Builder

mergeSetExpectation(DataQualityRule.SetExpectation value)

public DataQualityRule.Builder mergeSetExpectation(DataQualityRule.SetExpectation value)

ColumnMap rule which evaluates whether each column value is contained by a specified set.

.google.cloud.dataplex.v1.DataQualityRule.SetExpectation set_expectation = 3;

Parameter
NameDescription
valueDataQualityRule.SetExpectation
Returns
TypeDescription
DataQualityRule.Builder

mergeStatisticRangeExpectation(DataQualityRule.StatisticRangeExpectation value)

public DataQualityRule.Builder mergeStatisticRangeExpectation(DataQualityRule.StatisticRangeExpectation value)

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

.google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation statistic_range_expectation = 101;

Parameter
NameDescription
valueDataQualityRule.StatisticRangeExpectation
Returns
TypeDescription
DataQualityRule.Builder

mergeTableConditionExpectation(DataQualityRule.TableConditionExpectation value)

public DataQualityRule.Builder mergeTableConditionExpectation(DataQualityRule.TableConditionExpectation value)

Table rule which evaluates whether the provided expression is true.

.google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation table_condition_expectation = 201;

Parameter
NameDescription
valueDataQualityRule.TableConditionExpectation
Returns
TypeDescription
DataQualityRule.Builder

mergeUniquenessExpectation(DataQualityRule.UniquenessExpectation value)

public DataQualityRule.Builder mergeUniquenessExpectation(DataQualityRule.UniquenessExpectation value)

ColumnAggregate rule which evaluates whether the column has duplicates.

.google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;

Parameter
NameDescription
valueDataQualityRule.UniquenessExpectation
Returns
TypeDescription
DataQualityRule.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DataQualityRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DataQualityRule.Builder
Overrides

setColumn(String value)

public DataQualityRule.Builder setColumn(String value)

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

string column = 500 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The column to set.

Returns
TypeDescription
DataQualityRule.Builder

This builder for chaining.

setColumnBytes(ByteString value)

public DataQualityRule.Builder setColumnBytes(ByteString value)

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

string column = 500 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for column to set.

Returns
TypeDescription
DataQualityRule.Builder

This builder for chaining.

setDimension(String value)

public DataQualityRule.Builder setDimension(String value)

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];

Parameter
NameDescription
valueString

The dimension to set.

Returns
TypeDescription
DataQualityRule.Builder

This builder for chaining.

setDimensionBytes(ByteString value)

public DataQualityRule.Builder setDimensionBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for dimension to set.

Returns
TypeDescription
DataQualityRule.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DataQualityRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DataQualityRule.Builder
Overrides

setIgnoreNull(boolean value)

public DataQualityRule.Builder setIgnoreNull(boolean value)

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];

Parameter
NameDescription
valueboolean

The ignoreNull to set.

Returns
TypeDescription
DataQualityRule.Builder

This builder for chaining.

setNonNullExpectation(DataQualityRule.NonNullExpectation value)

public DataQualityRule.Builder setNonNullExpectation(DataQualityRule.NonNullExpectation value)

ColumnMap rule which evaluates whether each column value is null.

.google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation non_null_expectation = 2;

Parameter
NameDescription
valueDataQualityRule.NonNullExpectation
Returns
TypeDescription
DataQualityRule.Builder

setNonNullExpectation(DataQualityRule.NonNullExpectation.Builder builderForValue)

public DataQualityRule.Builder setNonNullExpectation(DataQualityRule.NonNullExpectation.Builder builderForValue)

ColumnMap rule which evaluates whether each column value is null.

.google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation non_null_expectation = 2;

Parameter
NameDescription
builderForValueDataQualityRule.NonNullExpectation.Builder
Returns
TypeDescription
DataQualityRule.Builder

setRangeExpectation(DataQualityRule.RangeExpectation value)

public DataQualityRule.Builder setRangeExpectation(DataQualityRule.RangeExpectation value)

ColumnMap rule which evaluates whether each column value lies between a specified range.

.google.cloud.dataplex.v1.DataQualityRule.RangeExpectation range_expectation = 1;

Parameter
NameDescription
valueDataQualityRule.RangeExpectation
Returns
TypeDescription
DataQualityRule.Builder

setRangeExpectation(DataQualityRule.RangeExpectation.Builder builderForValue)

public DataQualityRule.Builder setRangeExpectation(DataQualityRule.RangeExpectation.Builder builderForValue)

ColumnMap rule which evaluates whether each column value lies between a specified range.

.google.cloud.dataplex.v1.DataQualityRule.RangeExpectation range_expectation = 1;

Parameter
NameDescription
builderForValueDataQualityRule.RangeExpectation.Builder
Returns
TypeDescription
DataQualityRule.Builder

setRegexExpectation(DataQualityRule.RegexExpectation value)

public DataQualityRule.Builder setRegexExpectation(DataQualityRule.RegexExpectation value)

ColumnMap rule which evaluates whether each column value matches a specified regex.

.google.cloud.dataplex.v1.DataQualityRule.RegexExpectation regex_expectation = 4;

Parameter
NameDescription
valueDataQualityRule.RegexExpectation
Returns
TypeDescription
DataQualityRule.Builder

setRegexExpectation(DataQualityRule.RegexExpectation.Builder builderForValue)

public DataQualityRule.Builder setRegexExpectation(DataQualityRule.RegexExpectation.Builder builderForValue)

ColumnMap rule which evaluates whether each column value matches a specified regex.

.google.cloud.dataplex.v1.DataQualityRule.RegexExpectation regex_expectation = 4;

Parameter
NameDescription
builderForValueDataQualityRule.RegexExpectation.Builder
Returns
TypeDescription
DataQualityRule.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DataQualityRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DataQualityRule.Builder
Overrides

setRowConditionExpectation(DataQualityRule.RowConditionExpectation value)

public DataQualityRule.Builder setRowConditionExpectation(DataQualityRule.RowConditionExpectation value)

Table rule which evaluates whether each row passes the specified condition.

.google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation row_condition_expectation = 200;

Parameter
NameDescription
valueDataQualityRule.RowConditionExpectation
Returns
TypeDescription
DataQualityRule.Builder

setRowConditionExpectation(DataQualityRule.RowConditionExpectation.Builder builderForValue)

public DataQualityRule.Builder setRowConditionExpectation(DataQualityRule.RowConditionExpectation.Builder builderForValue)

Table rule which evaluates whether each row passes the specified condition.

.google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation row_condition_expectation = 200;

Parameter
NameDescription
builderForValueDataQualityRule.RowConditionExpectation.Builder
Returns
TypeDescription
DataQualityRule.Builder

setSetExpectation(DataQualityRule.SetExpectation value)

public DataQualityRule.Builder setSetExpectation(DataQualityRule.SetExpectation value)

ColumnMap rule which evaluates whether each column value is contained by a specified set.

.google.cloud.dataplex.v1.DataQualityRule.SetExpectation set_expectation = 3;

Parameter
NameDescription
valueDataQualityRule.SetExpectation
Returns
TypeDescription
DataQualityRule.Builder

setSetExpectation(DataQualityRule.SetExpectation.Builder builderForValue)

public DataQualityRule.Builder setSetExpectation(DataQualityRule.SetExpectation.Builder builderForValue)

ColumnMap rule which evaluates whether each column value is contained by a specified set.

.google.cloud.dataplex.v1.DataQualityRule.SetExpectation set_expectation = 3;

Parameter
NameDescription
builderForValueDataQualityRule.SetExpectation.Builder
Returns
TypeDescription
DataQualityRule.Builder

setStatisticRangeExpectation(DataQualityRule.StatisticRangeExpectation value)

public DataQualityRule.Builder setStatisticRangeExpectation(DataQualityRule.StatisticRangeExpectation value)

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

.google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation statistic_range_expectation = 101;

Parameter
NameDescription
valueDataQualityRule.StatisticRangeExpectation
Returns
TypeDescription
DataQualityRule.Builder

setStatisticRangeExpectation(DataQualityRule.StatisticRangeExpectation.Builder builderForValue)

public DataQualityRule.Builder setStatisticRangeExpectation(DataQualityRule.StatisticRangeExpectation.Builder builderForValue)

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

.google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation statistic_range_expectation = 101;

Parameter
NameDescription
builderForValueDataQualityRule.StatisticRangeExpectation.Builder
Returns
TypeDescription
DataQualityRule.Builder

setTableConditionExpectation(DataQualityRule.TableConditionExpectation value)

public DataQualityRule.Builder setTableConditionExpectation(DataQualityRule.TableConditionExpectation value)

Table rule which evaluates whether the provided expression is true.

.google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation table_condition_expectation = 201;

Parameter
NameDescription
valueDataQualityRule.TableConditionExpectation
Returns
TypeDescription
DataQualityRule.Builder

setTableConditionExpectation(DataQualityRule.TableConditionExpectation.Builder builderForValue)

public DataQualityRule.Builder setTableConditionExpectation(DataQualityRule.TableConditionExpectation.Builder builderForValue)

Table rule which evaluates whether the provided expression is true.

.google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation table_condition_expectation = 201;

Parameter
NameDescription
builderForValueDataQualityRule.TableConditionExpectation.Builder
Returns
TypeDescription
DataQualityRule.Builder

setThreshold(double value)

public DataQualityRule.Builder setThreshold(double value)

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];

Parameter
NameDescription
valuedouble

The threshold to set.

Returns
TypeDescription
DataQualityRule.Builder

This builder for chaining.

setUniquenessExpectation(DataQualityRule.UniquenessExpectation value)

public DataQualityRule.Builder setUniquenessExpectation(DataQualityRule.UniquenessExpectation value)

ColumnAggregate rule which evaluates whether the column has duplicates.

.google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;

Parameter
NameDescription
valueDataQualityRule.UniquenessExpectation
Returns
TypeDescription
DataQualityRule.Builder

setUniquenessExpectation(DataQualityRule.UniquenessExpectation.Builder builderForValue)

public DataQualityRule.Builder setUniquenessExpectation(DataQualityRule.UniquenessExpectation.Builder builderForValue)

ColumnAggregate rule which evaluates whether the column has duplicates.

.google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation uniqueness_expectation = 100;

Parameter
NameDescription
builderForValueDataQualityRule.UniquenessExpectation.Builder
Returns
TypeDescription
DataQualityRule.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final DataQualityRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DataQualityRule.Builder
Overrides