Class DataQualityRuleResult.Builder (1.61.0)

public static final class DataQualityRuleResult.Builder extends GeneratedMessageV3.Builder<DataQualityRuleResult.Builder> implements DataQualityRuleResultOrBuilder

DataQualityRuleResult provides a more detailed, per-rule view of the results.

Protobuf type google.cloud.dataplex.v1.DataQualityRuleResult

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DataQualityRuleResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DataQualityRuleResult.Builder
Overrides

build()

public DataQualityRuleResult build()
Returns
Type Description
DataQualityRuleResult

buildPartial()

public DataQualityRuleResult buildPartial()
Returns
Type Description
DataQualityRuleResult

clear()

public DataQualityRuleResult.Builder clear()
Returns
Type Description
DataQualityRuleResult.Builder
Overrides

clearAssertionRowCount()

public DataQualityRuleResult.Builder clearAssertionRowCount()

Output only. The number of rows returned by the SQL statement in a SQL assertion rule.

This field is only valid for SQL assertion rules.

int64 assertion_row_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleResult.Builder

This builder for chaining.

clearEvaluatedCount()

public DataQualityRuleResult.Builder clearEvaluatedCount()

Output only. The number of rows a rule was evaluated against.

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

Evaluated count can be configured to either

  • include all rows (default) - with null rows automatically failing rule evaluation, or
  • exclude null rows from the evaluated_count, by setting ignore_nulls = true.

    This field is not set for rule SqlAssertion.

int64 evaluated_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleResult.Builder

This builder for chaining.

clearFailingRowsQuery()

public DataQualityRuleResult.Builder clearFailingRowsQuery()

Output only. The query to find rows that did not pass this rule.

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

string failing_rows_query = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleResult.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DataQualityRuleResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DataQualityRuleResult.Builder
Overrides

clearNullCount()

public DataQualityRuleResult.Builder clearNullCount()

Output only. The number of rows with null values in the specified column.

int64 null_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleResult.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DataQualityRuleResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DataQualityRuleResult.Builder
Overrides

clearPassRatio()

public DataQualityRuleResult.Builder clearPassRatio()

Output only. The ratio of passed_count / evaluated_count.

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

double pass_ratio = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleResult.Builder

This builder for chaining.

clearPassed()

public DataQualityRuleResult.Builder clearPassed()

Output only. Whether the rule passed or failed.

bool passed = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleResult.Builder

This builder for chaining.

clearPassedCount()

public DataQualityRuleResult.Builder clearPassedCount()

Output only. The number of rows which passed a rule evaluation.

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

This field is not set for rule SqlAssertion.

int64 passed_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleResult.Builder

This builder for chaining.

clearRule()

public DataQualityRuleResult.Builder clearRule()

Output only. The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleResult.Builder

clone()

public DataQualityRuleResult.Builder clone()
Returns
Type Description
DataQualityRuleResult.Builder
Overrides

getAssertionRowCount()

public long getAssertionRowCount()

Output only. The number of rows returned by the SQL statement in a SQL assertion rule.

This field is only valid for SQL assertion rules.

int64 assertion_row_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The assertionRowCount.

getDefaultInstanceForType()

public DataQualityRuleResult getDefaultInstanceForType()
Returns
Type Description
DataQualityRuleResult

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEvaluatedCount()

public long getEvaluatedCount()

Output only. The number of rows a rule was evaluated against.

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

Evaluated count can be configured to either

  • include all rows (default) - with null rows automatically failing rule evaluation, or
  • exclude null rows from the evaluated_count, by setting ignore_nulls = true.

    This field is not set for rule SqlAssertion.

int64 evaluated_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The evaluatedCount.

getFailingRowsQuery()

public String getFailingRowsQuery()

Output only. The query to find rows that did not pass this rule.

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

string failing_rows_query = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The failingRowsQuery.

getFailingRowsQueryBytes()

public ByteString getFailingRowsQueryBytes()

Output only. The query to find rows that did not pass this rule.

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

string failing_rows_query = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for failingRowsQuery.

getNullCount()

public long getNullCount()

Output only. The number of rows with null values in the specified column.

int64 null_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The nullCount.

getPassRatio()

public double getPassRatio()

Output only. The ratio of passed_count / evaluated_count.

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

double pass_ratio = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
double

The passRatio.

getPassed()

public boolean getPassed()

Output only. Whether the rule passed or failed.

bool passed = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The passed.

getPassedCount()

public long getPassedCount()

Output only. The number of rows which passed a rule evaluation.

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

This field is not set for rule SqlAssertion.

int64 passed_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The passedCount.

getRule()

public DataQualityRule getRule()

Output only. The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRule

The rule.

getRuleBuilder()

public DataQualityRule.Builder getRuleBuilder()

Output only. The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRule.Builder

getRuleOrBuilder()

public DataQualityRuleOrBuilder getRuleOrBuilder()

Output only. The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleOrBuilder

hasRule()

public boolean hasRule()

Output only. The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the rule field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DataQualityRuleResult other)

public DataQualityRuleResult.Builder mergeFrom(DataQualityRuleResult other)
Parameter
Name Description
other DataQualityRuleResult
Returns
Type Description
DataQualityRuleResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataQualityRuleResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataQualityRuleResult.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DataQualityRuleResult.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DataQualityRuleResult.Builder
Overrides

mergeRule(DataQualityRule value)

public DataQualityRuleResult.Builder mergeRule(DataQualityRule value)

Output only. The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value DataQualityRule
Returns
Type Description
DataQualityRuleResult.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DataQualityRuleResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DataQualityRuleResult.Builder
Overrides

setAssertionRowCount(long value)

public DataQualityRuleResult.Builder setAssertionRowCount(long value)

Output only. The number of rows returned by the SQL statement in a SQL assertion rule.

This field is only valid for SQL assertion rules.

int64 assertion_row_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value long

The assertionRowCount to set.

Returns
Type Description
DataQualityRuleResult.Builder

This builder for chaining.

setEvaluatedCount(long value)

public DataQualityRuleResult.Builder setEvaluatedCount(long value)

Output only. The number of rows a rule was evaluated against.

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

Evaluated count can be configured to either

  • include all rows (default) - with null rows automatically failing rule evaluation, or
  • exclude null rows from the evaluated_count, by setting ignore_nulls = true.

    This field is not set for rule SqlAssertion.

int64 evaluated_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value long

The evaluatedCount to set.

Returns
Type Description
DataQualityRuleResult.Builder

This builder for chaining.

setFailingRowsQuery(String value)

public DataQualityRuleResult.Builder setFailingRowsQuery(String value)

Output only. The query to find rows that did not pass this rule.

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

string failing_rows_query = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The failingRowsQuery to set.

Returns
Type Description
DataQualityRuleResult.Builder

This builder for chaining.

setFailingRowsQueryBytes(ByteString value)

public DataQualityRuleResult.Builder setFailingRowsQueryBytes(ByteString value)

Output only. The query to find rows that did not pass this rule.

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

string failing_rows_query = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for failingRowsQuery to set.

Returns
Type Description
DataQualityRuleResult.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DataQualityRuleResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DataQualityRuleResult.Builder
Overrides

setNullCount(long value)

public DataQualityRuleResult.Builder setNullCount(long value)

Output only. The number of rows with null values in the specified column.

int64 null_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value long

The nullCount to set.

Returns
Type Description
DataQualityRuleResult.Builder

This builder for chaining.

setPassRatio(double value)

public DataQualityRuleResult.Builder setPassRatio(double value)

Output only. The ratio of passed_count / evaluated_count.

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

double pass_ratio = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value double

The passRatio to set.

Returns
Type Description
DataQualityRuleResult.Builder

This builder for chaining.

setPassed(boolean value)

public DataQualityRuleResult.Builder setPassed(boolean value)

Output only. Whether the rule passed or failed.

bool passed = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The passed to set.

Returns
Type Description
DataQualityRuleResult.Builder

This builder for chaining.

setPassedCount(long value)

public DataQualityRuleResult.Builder setPassedCount(long value)

Output only. The number of rows which passed a rule evaluation.

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

This field is not set for rule SqlAssertion.

int64 passed_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value long

The passedCount to set.

Returns
Type Description
DataQualityRuleResult.Builder

This builder for chaining.

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

public DataQualityRuleResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DataQualityRuleResult.Builder
Overrides

setRule(DataQualityRule value)

public DataQualityRuleResult.Builder setRule(DataQualityRule value)

Output only. The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value DataQualityRule
Returns
Type Description
DataQualityRuleResult.Builder

setRule(DataQualityRule.Builder builderForValue)

public DataQualityRuleResult.Builder setRule(DataQualityRule.Builder builderForValue)

Output only. The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue DataQualityRule.Builder
Returns
Type Description
DataQualityRuleResult.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final DataQualityRuleResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DataQualityRuleResult.Builder
Overrides