Class DataQualityRule.Builder (1.31.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DataQualityRule.Builder

Implements

DataQualityRuleOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DataQualityRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DataQualityRule.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public DataQualityRule build()

Returns
Type	Description
`DataQualityRule`

buildPartial()

public DataQualityRule buildPartial()

Returns
Type	Description
`DataQualityRule`

clear()

public DataQualityRule.Builder clear()

Returns
Type	Description
`DataQualityRule.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearColumn()

public DataQualityRule.Builder clearColumn()

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

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

Returns
Type	Description
`DataQualityRule.Builder`	This builder for chaining.

clearDescription()

public DataQualityRule.Builder clearDescription()

Optional. Description of the rule.

The maximum length is 1,024 characters.

string description = 505 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`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
Type	Description
`DataQualityRule.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DataQualityRule.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`DataQualityRule.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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.

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
`DataQualityRule.Builder`	This builder for chaining.

clearName()

public DataQualityRule.Builder clearName()

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
`DataQualityRule.Builder`	This builder for chaining.

clearNonNullExpectation()

public DataQualityRule.Builder clearNonNullExpectation()

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.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public DataQualityRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`DataQualityRule.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRangeExpectation()

public DataQualityRule.Builder clearRangeExpectation()

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.Builder`

clearRegexExpectation()

public DataQualityRule.Builder clearRegexExpectation()

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.Builder`

clearRowConditionExpectation()

public DataQualityRule.Builder clearRowConditionExpectation()

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.Builder`

clearRuleType()

public DataQualityRule.Builder clearRuleType()

Returns
Type	Description
`DataQualityRule.Builder`

clearSetExpectation()

public DataQualityRule.Builder clearSetExpectation()

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.Builder`

clearStatisticRangeExpectation()

public DataQualityRule.Builder clearStatisticRangeExpectation()

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.Builder`

clearTableConditionExpectation()

public DataQualityRule.Builder clearTableConditionExpectation()

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.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).

This field is only valid for row-level type rules.

double threshold = 503 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`DataQualityRule.Builder`	This builder for chaining.

clearUniquenessExpectation()

public DataQualityRule.Builder clearUniquenessExpectation()

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

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

Returns
Type	Description
`DataQualityRule.Builder`

clone()

public DataQualityRule.Builder clone()

Returns
Type	Description
`DataQualityRule.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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()

Returns
Type	Description
`DataQualityRule`

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDimension()

public String getDimension()

string dimension = 502 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The dimension.

getDimensionBytes()

public ByteString getDimensionBytes()

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()

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

Returns
Type	Description
`DataQualityRule.NonNullExpectation`	The nonNullExpectation.

getNonNullExpectationBuilder()

public DataQualityRule.NonNullExpectation.Builder getNonNullExpectationBuilder()

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.Builder`

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;

Returns
Type	Description
`DataQualityRule.NonNullExpectationOrBuilder`

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;

Returns
Type	Description
`DataQualityRule.RangeExpectation`	The rangeExpectation.

getRangeExpectationBuilder()

public DataQualityRule.RangeExpectation.Builder getRangeExpectationBuilder()

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.Builder`

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;

Returns
Type	Description
`DataQualityRule.RangeExpectationOrBuilder`

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;

Returns
Type	Description
`DataQualityRule.RegexExpectation`	The regexExpectation.

getRegexExpectationBuilder()

public DataQualityRule.RegexExpectation.Builder getRegexExpectationBuilder()

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.Builder`

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;

Returns
Type	Description
`DataQualityRule.RegexExpectationOrBuilder`

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;

Returns
Type	Description
`DataQualityRule.RowConditionExpectation`	The rowConditionExpectation.

getRowConditionExpectationBuilder()

public DataQualityRule.RowConditionExpectation.Builder getRowConditionExpectationBuilder()

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.Builder`

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;

Returns
Type	Description
`DataQualityRule.RowConditionExpectationOrBuilder`

getRuleTypeCase()

public DataQualityRule.RuleTypeCase getRuleTypeCase()

Returns
Type	Description
`DataQualityRule.RuleTypeCase`

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;

Returns
Type	Description
`DataQualityRule.SetExpectation`	The setExpectation.

getSetExpectationBuilder()

public DataQualityRule.SetExpectation.Builder getSetExpectationBuilder()

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.Builder`

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;

Returns
Type	Description
`DataQualityRule.SetExpectationOrBuilder`

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;

Returns
Type	Description
`DataQualityRule.StatisticRangeExpectation`	The statisticRangeExpectation.

getStatisticRangeExpectationBuilder()

public DataQualityRule.StatisticRangeExpectation.Builder getStatisticRangeExpectationBuilder()

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.Builder`

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;

Returns
Type	Description
`DataQualityRule.StatisticRangeExpectationOrBuilder`

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;

Returns
Type	Description
`DataQualityRule.TableConditionExpectation`	The tableConditionExpectation.

getTableConditionExpectationBuilder()

public DataQualityRule.TableConditionExpectation.Builder getTableConditionExpectationBuilder()

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.Builder`

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;

Returns
Type	Description
`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).

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;

Returns
Type	Description
`DataQualityRule.UniquenessExpectation`	The uniquenessExpectation.

getUniquenessExpectationBuilder()

public DataQualityRule.UniquenessExpectation.Builder getUniquenessExpectationBuilder()

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.Builder`

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;

Returns
Type	Description
`DataQualityRule.UniquenessExpectationOrBuilder`

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(DataQualityRule other)

public DataQualityRule.Builder mergeFrom(DataQualityRule other)

Parameter
Name	Description
`other`	`DataQualityRule`

Returns
Type	Description
`DataQualityRule.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataQualityRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DataQualityRule.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public DataQualityRule.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`DataQualityRule.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeNonNullExpectation(DataQualityRule.NonNullExpectation value)

public DataQualityRule.Builder mergeNonNullExpectation(DataQualityRule.NonNullExpectation value)

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

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

Parameter
Name	Description
`value`	`DataQualityRule.NonNullExpectation`

Returns
Type	Description
`DataQualityRule.Builder`

mergeRangeExpectation(DataQualityRule.RangeExpectation value)

public DataQualityRule.Builder mergeRangeExpectation(DataQualityRule.RangeExpectation value)

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

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

Parameter
Name	Description
`value`	`DataQualityRule.RangeExpectation`

Returns
Type	Description
`DataQualityRule.Builder`

mergeRegexExpectation(DataQualityRule.RegexExpectation value)

public DataQualityRule.Builder mergeRegexExpectation(DataQualityRule.RegexExpectation value)

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

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

Parameter
Name	Description
`value`	`DataQualityRule.RegexExpectation`

Returns
Type	Description
`DataQualityRule.Builder`

mergeRowConditionExpectation(DataQualityRule.RowConditionExpectation value)

public DataQualityRule.Builder mergeRowConditionExpectation(DataQualityRule.RowConditionExpectation value)

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;

Parameter
Name	Description
`value`	`DataQualityRule.RowConditionExpectation`

Returns
Type	Description
`DataQualityRule.Builder`

mergeSetExpectation(DataQualityRule.SetExpectation value)

public DataQualityRule.Builder mergeSetExpectation(DataQualityRule.SetExpectation value)

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

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

Parameter
Name	Description
`value`	`DataQualityRule.SetExpectation`

Returns
Type	Description
`DataQualityRule.Builder`

mergeStatisticRangeExpectation(DataQualityRule.StatisticRangeExpectation value)

public DataQualityRule.Builder mergeStatisticRangeExpectation(DataQualityRule.StatisticRangeExpectation value)

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

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

Parameter
Name	Description
`value`	`DataQualityRule.StatisticRangeExpectation`

Returns
Type	Description
`DataQualityRule.Builder`

mergeTableConditionExpectation(DataQualityRule.TableConditionExpectation value)

public DataQualityRule.Builder mergeTableConditionExpectation(DataQualityRule.TableConditionExpectation value)

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

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

Parameter
Name	Description
`value`	`DataQualityRule.TableConditionExpectation`

Returns
Type	Description
`DataQualityRule.Builder`

mergeUniquenessExpectation(DataQualityRule.UniquenessExpectation value)

public DataQualityRule.Builder mergeUniquenessExpectation(DataQualityRule.UniquenessExpectation value)

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

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

Parameter
Name	Description
`value`	`DataQualityRule.UniquenessExpectation`

Returns
Type	Description
`DataQualityRule.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DataQualityRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DataQualityRule.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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
Name	Description
`value`	`String` The column to set.

Returns
Type	Description
`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
Name	Description
`value`	`ByteString` The bytes for column to set.

Returns
Type	Description
`DataQualityRule.Builder`	This builder for chaining.

setDescription(String value)

public DataQualityRule.Builder setDescription(String value)

Optional. Description of the rule.

The maximum length is 1,024 characters.

string description = 505 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`String` The description to set.

Returns
Type	Description
`DataQualityRule.Builder`	This builder for chaining.

setDescriptionBytes(ByteString value)

public DataQualityRule.Builder setDescriptionBytes(ByteString value)

Optional. Description of the rule.

The maximum length is 1,024 characters.

string description = 505 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ByteString` The bytes for description to set.

Returns
Type	Description
`DataQualityRule.Builder`	This builder for chaining.

setDimension(String value)

public DataQualityRule.Builder setDimension(String value)

string dimension = 502 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`String` The dimension to set.

Returns
Type	Description
`DataQualityRule.Builder`	This builder for chaining.

setDimensionBytes(ByteString value)

public DataQualityRule.Builder setDimensionBytes(ByteString value)

string dimension = 502 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`ByteString` The bytes for dimension to set.

Returns
Type	Description
`DataQualityRule.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DataQualityRule.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DataQualityRule.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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.

This field is only valid for the following type of rules:

RangeExpectation
RegexExpectation
SetExpectation
UniquenessExpectation

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

Parameter
Name	Description
`value`	`boolean` The ignoreNull to set.

Returns
Type	Description
`DataQualityRule.Builder`	This builder for chaining.

setName(String value)

public DataQualityRule.Builder setName(String value)

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

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`DataQualityRule.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public DataQualityRule.Builder setNameBytes(ByteString value)

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

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`DataQualityRule.Builder`	This builder for chaining.

setNonNullExpectation(DataQualityRule.NonNullExpectation value)

public DataQualityRule.Builder setNonNullExpectation(DataQualityRule.NonNullExpectation value)

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

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

Parameter
Name	Description
`value`	`DataQualityRule.NonNullExpectation`

Returns
Type	Description
`DataQualityRule.Builder`

setNonNullExpectation(DataQualityRule.NonNullExpectation.Builder builderForValue)

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

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

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

Parameter
Name	Description
`builderForValue`	`DataQualityRule.NonNullExpectation.Builder`

Returns
Type	Description
`DataQualityRule.Builder`

setRangeExpectation(DataQualityRule.RangeExpectation value)

public DataQualityRule.Builder setRangeExpectation(DataQualityRule.RangeExpectation value)

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

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

Parameter
Name	Description
`value`	`DataQualityRule.RangeExpectation`

Returns
Type	Description
`DataQualityRule.Builder`

setRangeExpectation(DataQualityRule.RangeExpectation.Builder builderForValue)

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

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

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

Parameter
Name	Description
`builderForValue`	`DataQualityRule.RangeExpectation.Builder`

Returns
Type	Description
`DataQualityRule.Builder`

setRegexExpectation(DataQualityRule.RegexExpectation value)

public DataQualityRule.Builder setRegexExpectation(DataQualityRule.RegexExpectation value)

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

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

Parameter
Name	Description
`value`	`DataQualityRule.RegexExpectation`

Returns
Type	Description
`DataQualityRule.Builder`

setRegexExpectation(DataQualityRule.RegexExpectation.Builder builderForValue)

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

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

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

Parameter
Name	Description
`builderForValue`	`DataQualityRule.RegexExpectation.Builder`

Returns
Type	Description
`DataQualityRule.Builder`

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`DataQualityRule.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRowConditionExpectation(DataQualityRule.RowConditionExpectation value)

public DataQualityRule.Builder setRowConditionExpectation(DataQualityRule.RowConditionExpectation value)

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;

Parameter
Name	Description
`value`	`DataQualityRule.RowConditionExpectation`

Returns
Type	Description
`DataQualityRule.Builder`

setRowConditionExpectation(DataQualityRule.RowConditionExpectation.Builder builderForValue)

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

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;

Parameter
Name	Description
`builderForValue`	`DataQualityRule.RowConditionExpectation.Builder`

Returns
Type	Description
`DataQualityRule.Builder`

setSetExpectation(DataQualityRule.SetExpectation value)

public DataQualityRule.Builder setSetExpectation(DataQualityRule.SetExpectation value)

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

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

Parameter
Name	Description
`value`	`DataQualityRule.SetExpectation`

Returns
Type	Description
`DataQualityRule.Builder`

setSetExpectation(DataQualityRule.SetExpectation.Builder builderForValue)

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

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

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

Parameter
Name	Description
`builderForValue`	`DataQualityRule.SetExpectation.Builder`

Returns
Type	Description
`DataQualityRule.Builder`

setStatisticRangeExpectation(DataQualityRule.StatisticRangeExpectation value)

public DataQualityRule.Builder setStatisticRangeExpectation(DataQualityRule.StatisticRangeExpectation value)

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

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

Parameter
Name	Description
`value`	`DataQualityRule.StatisticRangeExpectation`

Returns
Type	Description
`DataQualityRule.Builder`

setStatisticRangeExpectation(DataQualityRule.StatisticRangeExpectation.Builder builderForValue)

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

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

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

Parameter
Name	Description
`builderForValue`	`DataQualityRule.StatisticRangeExpectation.Builder`

Returns
Type	Description
`DataQualityRule.Builder`

setTableConditionExpectation(DataQualityRule.TableConditionExpectation value)

public DataQualityRule.Builder setTableConditionExpectation(DataQualityRule.TableConditionExpectation value)

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

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

Parameter
Name	Description
`value`	`DataQualityRule.TableConditionExpectation`

Returns
Type	Description
`DataQualityRule.Builder`

setTableConditionExpectation(DataQualityRule.TableConditionExpectation.Builder builderForValue)

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

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

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

Parameter
Name	Description
`builderForValue`	`DataQualityRule.TableConditionExpectation.Builder`

Returns
Type	Description
`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).

This field is only valid for row-level type rules.

double threshold = 503 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`double` The threshold to set.

Returns
Type	Description
`DataQualityRule.Builder`	This builder for chaining.

setUniquenessExpectation(DataQualityRule.UniquenessExpectation value)

public DataQualityRule.Builder setUniquenessExpectation(DataQualityRule.UniquenessExpectation value)

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

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

Parameter
Name	Description
`value`	`DataQualityRule.UniquenessExpectation`

Returns
Type	Description
`DataQualityRule.Builder`

setUniquenessExpectation(DataQualityRule.UniquenessExpectation.Builder builderForValue)

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

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

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

Parameter
Name	Description
`builderForValue`	`DataQualityRule.UniquenessExpectation.Builder`

Returns
Type	Description
`DataQualityRule.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final DataQualityRule.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DataQualityRule.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)