Class DataQualityRule.Builder (1.91.0)

1.91.0 (latest) 1.89.0 1.86.0 1.85.0 1.83.0 1.81.0 1.80.0 1.79.0 1.78.0 1.76.0 1.74.0 1.73.0 1.72.0 1.71.0 1.70.0 1.68.0 1.66.0 1.65.0 1.62.0 1.61.0 1.60.0 1.58.0 1.57.0 1.56.0 1.55.0 1.54.0 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.47.0 1.46.0 1.45.0 1.44.0 1.43.0 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.0 1.12.0 1.11.0 1.10.0 1.9.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.2 1.0.1 0.2.2

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

A rule captures data quality intent about a data source.

Protobuf type google.cloud.dataplex.v1.DataQualityRule

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.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)

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

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

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

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

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

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

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

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

GeneratedMessage.Builder.internalGetMutableMapField(int)

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

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

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

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

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

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

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

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

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

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.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

addAllDebugQueries(Iterable<? extends DataQualityRule.DebugQuery> values)

public DataQualityRule.Builder addAllDebugQueries(Iterable<? extends DataQualityRule.DebugQuery> values)

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.dataplex.v1.DataQualityRule.DebugQuery>

Returns
Type	Description
DataQualityRule.Builder

addDebugQueries(DataQualityRule.DebugQuery value)

public DataQualityRule.Builder addDebugQueries(DataQualityRule.DebugQuery value)

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	DataQualityRule.DebugQuery

Returns
Type	Description
DataQualityRule.Builder

addDebugQueries(DataQualityRule.DebugQuery.Builder builderForValue)

public DataQualityRule.Builder addDebugQueries(DataQualityRule.DebugQuery.Builder builderForValue)

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	DataQualityRule.DebugQuery.Builder

Returns
Type	Description
DataQualityRule.Builder

addDebugQueries(int index, DataQualityRule.DebugQuery value)

public DataQualityRule.Builder addDebugQueries(int index, DataQualityRule.DebugQuery value)

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	DataQualityRule.DebugQuery

Returns
Type	Description
DataQualityRule.Builder

addDebugQueries(int index, DataQualityRule.DebugQuery.Builder builderForValue)

public DataQualityRule.Builder addDebugQueries(int index, DataQualityRule.DebugQuery.Builder builderForValue)

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	DataQualityRule.DebugQuery.Builder

Returns
Type	Description
DataQualityRule.Builder

addDebugQueriesBuilder()

public DataQualityRule.DebugQuery.Builder addDebugQueriesBuilder()

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataQualityRule.DebugQuery.Builder

addDebugQueriesBuilder(int index)

public DataQualityRule.DebugQuery.Builder addDebugQueriesBuilder(int index)

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataQualityRule.DebugQuery.Builder

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

GeneratedMessage.Builder<BuilderType>.clear()

clearAttributes()

public DataQualityRule.Builder clearAttributes()

Returns
Type	Description
DataQualityRule.Builder

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.

clearDebugQueries()

public DataQualityRule.Builder clearDebugQueries()

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataQualityRule.Builder

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

Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.

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

Returns
Type	Description
DataQualityRule.Builder	This builder for chaining.

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

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

clearRuleSource()

public DataQualityRule.Builder clearRuleSource()

Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable.

.google.cloud.dataplex.v1.DataQualityRule.RuleSource rule_source = 508 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

clearSqlAssertion()

public DataQualityRule.Builder clearSqlAssertion()

Aggregate rule which evaluates the number of rows returned for the provided statement. If any rows are returned, this rule fails.

.google.cloud.dataplex.v1.DataQualityRule.SqlAssertion sql_assertion = 202;

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

clearSuspended()

public DataQualityRule.Builder clearSuspended()

Optional. Whether the Rule is active or suspended. Default is false.

bool suspended = 506 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataQualityRule.Builder	This builder for chaining.

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

clearTemplateReference()

public DataQualityRule.Builder clearTemplateReference()

Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails.

.google.cloud.dataplex.v1.DataQualityRule.TemplateReference template_reference = 5;

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

containsAttributes(String key)

public boolean containsAttributes(String key)

Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field.

map<string, string> attributes = 507 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAttributes() (deprecated)

public Map<String,String> getAttributes()

Use #getAttributesMap() instead.

Returns
Type	Description
Map<String,String>

getAttributesCount()

public int getAttributesCount()

Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field.

map<string, string> attributes = 507 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getAttributesMap()

public Map<String,String> getAttributesMap()

Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field.

map<string, string> attributes = 507 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getAttributesOrDefault(String key, String defaultValue)

public String getAttributesOrDefault(String key, String defaultValue)

Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field.

map<string, string> attributes = 507 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getAttributesOrThrow(String key)

public String getAttributesOrThrow(String key)

Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field.

map<string, string> attributes = 507 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
String

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.

getDebugQueries(int index)

public DataQualityRule.DebugQuery getDebugQueries(int index)

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataQualityRule.DebugQuery

getDebugQueriesBuilder(int index)

public DataQualityRule.DebugQuery.Builder getDebugQueriesBuilder(int index)

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataQualityRule.DebugQuery.Builder

getDebugQueriesBuilderList()

public List<DataQualityRule.DebugQuery.Builder> getDebugQueriesBuilderList()

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Builder>

getDebugQueriesCount()

public int getDebugQueriesCount()

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getDebugQueriesList()

public List<DataQualityRule.DebugQuery> getDebugQueriesList()

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<DebugQuery>

getDebugQueriesOrBuilder(int index)

public DataQualityRule.DebugQueryOrBuilder getDebugQueriesOrBuilder(int index)

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataQualityRule.DebugQueryOrBuilder

getDebugQueriesOrBuilderList()

public List<? extends DataQualityRule.DebugQueryOrBuilder> getDebugQueriesOrBuilderList()

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.dataplex.v1.DataQualityRule.DebugQueryOrBuilder>

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

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getDimension()

public String getDimension()

Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.

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

Returns
Type	Description
String	The dimension.

getDimensionBytes()

public ByteString getDimensionBytes()

Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.

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

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.

getMutableAttributes() (deprecated)

public Map<String,String> getMutableAttributes()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,String>

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

getRuleSource()

public DataQualityRule.RuleSource getRuleSource()

Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable.

.google.cloud.dataplex.v1.DataQualityRule.RuleSource rule_source = 508 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DataQualityRule.RuleSource	The ruleSource.

getRuleSourceBuilder()

public DataQualityRule.RuleSource.Builder getRuleSourceBuilder()

Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable.

.google.cloud.dataplex.v1.DataQualityRule.RuleSource rule_source = 508 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DataQualityRule.RuleSource.Builder

getRuleSourceOrBuilder()

public DataQualityRule.RuleSourceOrBuilder getRuleSourceOrBuilder()

Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable.

.google.cloud.dataplex.v1.DataQualityRule.RuleSource rule_source = 508 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DataQualityRule.RuleSourceOrBuilder

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

getSqlAssertion()

public DataQualityRule.SqlAssertion getSqlAssertion()

Aggregate rule which evaluates the number of rows returned for the provided statement. If any rows are returned, this rule fails.

.google.cloud.dataplex.v1.DataQualityRule.SqlAssertion sql_assertion = 202;

Returns
Type	Description
DataQualityRule.SqlAssertion	The sqlAssertion.

getSqlAssertionBuilder()

public DataQualityRule.SqlAssertion.Builder getSqlAssertionBuilder()

Aggregate rule which evaluates the number of rows returned for the provided statement. If any rows are returned, this rule fails.

.google.cloud.dataplex.v1.DataQualityRule.SqlAssertion sql_assertion = 202;

Returns
Type	Description
DataQualityRule.SqlAssertion.Builder

getSqlAssertionOrBuilder()

public DataQualityRule.SqlAssertionOrBuilder getSqlAssertionOrBuilder()

Aggregate rule which evaluates the number of rows returned for the provided statement. If any rows are returned, this rule fails.

.google.cloud.dataplex.v1.DataQualityRule.SqlAssertion sql_assertion = 202;

Returns
Type	Description
DataQualityRule.SqlAssertionOrBuilder

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

getSuspended()

public boolean getSuspended()

Optional. Whether the Rule is active or suspended. Default is false.

bool suspended = 506 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The suspended.

getTableConditionExpectation()

public DataQualityRule.TableConditionExpectation getTableConditionExpectation()

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

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

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

getTemplateReference()

public DataQualityRule.TemplateReference getTemplateReference()

Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails.

.google.cloud.dataplex.v1.DataQualityRule.TemplateReference template_reference = 5;

Returns
Type	Description
DataQualityRule.TemplateReference	The templateReference.

getTemplateReferenceBuilder()

public DataQualityRule.TemplateReference.Builder getTemplateReferenceBuilder()

Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails.

.google.cloud.dataplex.v1.DataQualityRule.TemplateReference template_reference = 5;

Returns
Type	Description
DataQualityRule.TemplateReference.Builder

getTemplateReferenceOrBuilder()

public DataQualityRule.TemplateReferenceOrBuilder getTemplateReferenceOrBuilder()

Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails.

.google.cloud.dataplex.v1.DataQualityRule.TemplateReference template_reference = 5;

Returns
Type	Description
DataQualityRule.TemplateReferenceOrBuilder

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.

hasRuleSource()

public boolean hasRuleSource()

Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable.

.google.cloud.dataplex.v1.DataQualityRule.RuleSource rule_source = 508 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the ruleSource field is set.

hasSetExpectation()

public boolean hasSetExpectation()

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

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

Returns
Type	Description
boolean	Whether the setExpectation field is set.

hasSqlAssertion()

public boolean hasSqlAssertion()

Aggregate rule which evaluates the number of rows returned for the provided statement. If any rows are returned, this rule fails.

.google.cloud.dataplex.v1.DataQualityRule.SqlAssertion sql_assertion = 202;

Returns
Type	Description
boolean	Whether the sqlAssertion field is set.

hasStatisticRangeExpectation()

public boolean hasStatisticRangeExpectation()

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

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

Returns
Type	Description
boolean	Whether the statisticRangeExpectation field is set.

hasTableConditionExpectation()

public boolean hasTableConditionExpectation()

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

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

Returns
Type	Description
boolean	Whether the tableConditionExpectation field is set.

hasTemplateReference()

public boolean hasTemplateReference()

Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails.

.google.cloud.dataplex.v1.DataQualityRule.TemplateReference template_reference = 5;

Returns
Type	Description
boolean	Whether the templateReference 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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

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

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

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

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

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

mergeRuleSource(DataQualityRule.RuleSource value)

public DataQualityRule.Builder mergeRuleSource(DataQualityRule.RuleSource value)

Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable.

.google.cloud.dataplex.v1.DataQualityRule.RuleSource rule_source = 508 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	DataQualityRule.RuleSource

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

mergeSqlAssertion(DataQualityRule.SqlAssertion value)

public DataQualityRule.Builder mergeSqlAssertion(DataQualityRule.SqlAssertion value)

Aggregate rule which evaluates the number of rows returned for the provided statement. If any rows are returned, this rule fails.

.google.cloud.dataplex.v1.DataQualityRule.SqlAssertion sql_assertion = 202;

Parameter
Name	Description
value	DataQualityRule.SqlAssertion

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

mergeTemplateReference(DataQualityRule.TemplateReference value)

public DataQualityRule.Builder mergeTemplateReference(DataQualityRule.TemplateReference value)

Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails.

.google.cloud.dataplex.v1.DataQualityRule.TemplateReference template_reference = 5;

Parameter
Name	Description
value	DataQualityRule.TemplateReference

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

putAllAttributes(Map<String,String> values)

public DataQualityRule.Builder putAllAttributes(Map<String,String> values)

Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field.

map<string, string> attributes = 507 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Map<String,String>

Returns
Type	Description
DataQualityRule.Builder

putAttributes(String key, String value)

public DataQualityRule.Builder putAttributes(String key, String value)

Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field.

map<string, string> attributes = 507 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
value	String

Returns
Type	Description
DataQualityRule.Builder

removeAttributes(String key)

public DataQualityRule.Builder removeAttributes(String key)

Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field.

map<string, string> attributes = 507 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
DataQualityRule.Builder

removeDebugQueries(int index)

public DataQualityRule.Builder removeDebugQueries(int index)

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataQualityRule.Builder

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.

setDebugQueries(int index, DataQualityRule.DebugQuery value)

public DataQualityRule.Builder setDebugQueries(int index, DataQualityRule.DebugQuery value)

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	DataQualityRule.DebugQuery

Returns
Type	Description
DataQualityRule.Builder

setDebugQueries(int index, DataQualityRule.DebugQuery.Builder builderForValue)

public DataQualityRule.Builder setDebugQueries(int index, DataQualityRule.DebugQuery.Builder builderForValue)

Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.

repeated .google.cloud.dataplex.v1.DataQualityRule.DebugQuery debug_queries = 510 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	DataQualityRule.DebugQuery.Builder

Returns
Type	Description
DataQualityRule.Builder

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)

Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.

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

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)

Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.

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

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

Returns
Type	Description
DataQualityRule.Builder	This builder for chaining.

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

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

setRuleSource(DataQualityRule.RuleSource value)

public DataQualityRule.Builder setRuleSource(DataQualityRule.RuleSource value)

Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable.

.google.cloud.dataplex.v1.DataQualityRule.RuleSource rule_source = 508 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	DataQualityRule.RuleSource

Returns
Type	Description
DataQualityRule.Builder

setRuleSource(DataQualityRule.RuleSource.Builder builderForValue)

public DataQualityRule.Builder setRuleSource(DataQualityRule.RuleSource.Builder builderForValue)

Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable.

.google.cloud.dataplex.v1.DataQualityRule.RuleSource rule_source = 508 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
builderForValue	DataQualityRule.RuleSource.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

setSqlAssertion(DataQualityRule.SqlAssertion value)

public DataQualityRule.Builder setSqlAssertion(DataQualityRule.SqlAssertion value)

Aggregate rule which evaluates the number of rows returned for the provided statement. If any rows are returned, this rule fails.

.google.cloud.dataplex.v1.DataQualityRule.SqlAssertion sql_assertion = 202;

Parameter
Name	Description
value	DataQualityRule.SqlAssertion

Returns
Type	Description
DataQualityRule.Builder

setSqlAssertion(DataQualityRule.SqlAssertion.Builder builderForValue)

public DataQualityRule.Builder setSqlAssertion(DataQualityRule.SqlAssertion.Builder builderForValue)

Aggregate rule which evaluates the number of rows returned for the provided statement. If any rows are returned, this rule fails.

.google.cloud.dataplex.v1.DataQualityRule.SqlAssertion sql_assertion = 202;

Parameter
Name	Description
builderForValue	DataQualityRule.SqlAssertion.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

setSuspended(boolean value)

public DataQualityRule.Builder setSuspended(boolean value)

Optional. Whether the Rule is active or suspended. Default is false.

bool suspended = 506 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The suspended to set.

Returns
Type	Description
DataQualityRule.Builder	This builder for chaining.

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

setTemplateReference(DataQualityRule.TemplateReference value)

public DataQualityRule.Builder setTemplateReference(DataQualityRule.TemplateReference value)

Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails.

.google.cloud.dataplex.v1.DataQualityRule.TemplateReference template_reference = 5;

Parameter
Name	Description
value	DataQualityRule.TemplateReference

Returns
Type	Description
DataQualityRule.Builder

setTemplateReference(DataQualityRule.TemplateReference.Builder builderForValue)

public DataQualityRule.Builder setTemplateReference(DataQualityRule.TemplateReference.Builder builderForValue)

Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails.

.google.cloud.dataplex.v1.DataQualityRule.TemplateReference template_reference = 5;

Parameter
Name	Description
builderForValue	DataQualityRule.TemplateReference.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