Class DataQualityRuleResult.Builder (1.17.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public DataQualityRuleResult build()
Returns
TypeDescription
DataQualityRuleResult

buildPartial()

public DataQualityRuleResult buildPartial()
Returns
TypeDescription
DataQualityRuleResult

clear()

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

clearEvaluatedCount()

public DataQualityRuleResult.Builder clearEvaluatedCount()

The number of rows a rule was evaluated against. This field is only valid for ColumnMap 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.

int64 evaluated_count = 9;

Returns
TypeDescription
DataQualityRuleResult.Builder

This builder for chaining.

clearFailingRowsQuery()

public DataQualityRuleResult.Builder clearFailingRowsQuery()

The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.

string failing_rows_query = 10;

Returns
TypeDescription
DataQualityRuleResult.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearNullCount()

public DataQualityRuleResult.Builder clearNullCount()

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

int64 null_count = 5;

Returns
TypeDescription
DataQualityRuleResult.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPassRatio()

public DataQualityRuleResult.Builder clearPassRatio()

The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.

double pass_ratio = 6;

Returns
TypeDescription
DataQualityRuleResult.Builder

This builder for chaining.

clearPassed()

public DataQualityRuleResult.Builder clearPassed()

Whether the rule passed or failed.

bool passed = 7;

Returns
TypeDescription
DataQualityRuleResult.Builder

This builder for chaining.

clearPassedCount()

public DataQualityRuleResult.Builder clearPassedCount()

The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.

int64 passed_count = 8;

Returns
TypeDescription
DataQualityRuleResult.Builder

This builder for chaining.

clearRule()

public DataQualityRuleResult.Builder clearRule()

The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1;

Returns
TypeDescription
DataQualityRuleResult.Builder

clone()

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

getDefaultInstanceForType()

public DataQualityRuleResult getDefaultInstanceForType()
Returns
TypeDescription
DataQualityRuleResult

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEvaluatedCount()

public long getEvaluatedCount()

The number of rows a rule was evaluated against. This field is only valid for ColumnMap 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.

int64 evaluated_count = 9;

Returns
TypeDescription
long

The evaluatedCount.

getFailingRowsQuery()

public String getFailingRowsQuery()

The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.

string failing_rows_query = 10;

Returns
TypeDescription
String

The failingRowsQuery.

getFailingRowsQueryBytes()

public ByteString getFailingRowsQueryBytes()

The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.

string failing_rows_query = 10;

Returns
TypeDescription
ByteString

The bytes for failingRowsQuery.

getNullCount()

public long getNullCount()

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

int64 null_count = 5;

Returns
TypeDescription
long

The nullCount.

getPassRatio()

public double getPassRatio()

The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.

double pass_ratio = 6;

Returns
TypeDescription
double

The passRatio.

getPassed()

public boolean getPassed()

Whether the rule passed or failed.

bool passed = 7;

Returns
TypeDescription
boolean

The passed.

getPassedCount()

public long getPassedCount()

The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.

int64 passed_count = 8;

Returns
TypeDescription
long

The passedCount.

getRule()

public DataQualityRule getRule()

The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1;

Returns
TypeDescription
DataQualityRule

The rule.

getRuleBuilder()

public DataQualityRule.Builder getRuleBuilder()

The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1;

Returns
TypeDescription
DataQualityRule.Builder

getRuleOrBuilder()

public DataQualityRuleOrBuilder getRuleOrBuilder()

The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1;

Returns
TypeDescription
DataQualityRuleOrBuilder

hasRule()

public boolean hasRule()

The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1;

Returns
TypeDescription
boolean

Whether the rule field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(DataQualityRuleResult other)

public DataQualityRuleResult.Builder mergeFrom(DataQualityRuleResult other)
Parameter
NameDescription
otherDataQualityRuleResult
Returns
TypeDescription
DataQualityRuleResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeRule(DataQualityRule value)

public DataQualityRuleResult.Builder mergeRule(DataQualityRule value)

The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1;

Parameter
NameDescription
valueDataQualityRule
Returns
TypeDescription
DataQualityRuleResult.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setEvaluatedCount(long value)

public DataQualityRuleResult.Builder setEvaluatedCount(long value)

The number of rows a rule was evaluated against. This field is only valid for ColumnMap 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.

int64 evaluated_count = 9;

Parameter
NameDescription
valuelong

The evaluatedCount to set.

Returns
TypeDescription
DataQualityRuleResult.Builder

This builder for chaining.

setFailingRowsQuery(String value)

public DataQualityRuleResult.Builder setFailingRowsQuery(String value)

The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.

string failing_rows_query = 10;

Parameter
NameDescription
valueString

The failingRowsQuery to set.

Returns
TypeDescription
DataQualityRuleResult.Builder

This builder for chaining.

setFailingRowsQueryBytes(ByteString value)

public DataQualityRuleResult.Builder setFailingRowsQueryBytes(ByteString value)

The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.

string failing_rows_query = 10;

Parameter
NameDescription
valueByteString

The bytes for failingRowsQuery to set.

Returns
TypeDescription
DataQualityRuleResult.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setNullCount(long value)

public DataQualityRuleResult.Builder setNullCount(long value)

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

int64 null_count = 5;

Parameter
NameDescription
valuelong

The nullCount to set.

Returns
TypeDescription
DataQualityRuleResult.Builder

This builder for chaining.

setPassRatio(double value)

public DataQualityRuleResult.Builder setPassRatio(double value)

The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.

double pass_ratio = 6;

Parameter
NameDescription
valuedouble

The passRatio to set.

Returns
TypeDescription
DataQualityRuleResult.Builder

This builder for chaining.

setPassed(boolean value)

public DataQualityRuleResult.Builder setPassed(boolean value)

Whether the rule passed or failed.

bool passed = 7;

Parameter
NameDescription
valueboolean

The passed to set.

Returns
TypeDescription
DataQualityRuleResult.Builder

This builder for chaining.

setPassedCount(long value)

public DataQualityRuleResult.Builder setPassedCount(long value)

The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.

int64 passed_count = 8;

Parameter
NameDescription
valuelong

The passedCount to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DataQualityRuleResult.Builder
Overrides

setRule(DataQualityRule value)

public DataQualityRuleResult.Builder setRule(DataQualityRule value)

The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1;

Parameter
NameDescription
valueDataQualityRule
Returns
TypeDescription
DataQualityRuleResult.Builder

setRule(DataQualityRule.Builder builderForValue)

public DataQualityRuleResult.Builder setRule(DataQualityRule.Builder builderForValue)

The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1;

Parameter
NameDescription
builderForValueDataQualityRule.Builder
Returns
TypeDescription
DataQualityRuleResult.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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