Class DataQualityScanRuleResult.Builder (1.40.0)

public static final class DataQualityScanRuleResult.Builder extends GeneratedMessageV3.Builder<DataQualityScanRuleResult.Builder> implements DataQualityScanRuleResultOrBuilder

Information about the result of a data quality rule for data quality scan. The monitored resource is 'DataScan'.

Protobuf type google.cloud.dataplex.v1.DataQualityScanRuleResult

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public DataQualityScanRuleResult build()
Returns
Type Description
DataQualityScanRuleResult

buildPartial()

public DataQualityScanRuleResult buildPartial()
Returns
Type Description
DataQualityScanRuleResult

clear()

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

clearColumn()

public DataQualityScanRuleResult.Builder clearColumn()

The column which this rule is evaluated against.

string column = 3;

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

clearDataSource()

public DataQualityScanRuleResult.Builder clearDataSource()

The data source of the data scan (e.g. BigQuery table name).

string data_source = 2;

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

clearEvaluatedRowCount()

public DataQualityScanRuleResult.Builder clearEvaluatedRowCount()

The number of rows evaluated against the data quality rule. This field is only valid for rules of PER_ROW evaluation type.

int64 evaluated_row_count = 10;

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

clearEvalutionType()

public DataQualityScanRuleResult.Builder clearEvalutionType()

The evaluation type of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.EvaluationType evalution_type = 6;

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearJobId()

public DataQualityScanRuleResult.Builder clearJobId()

Identifier of the specific data scan job this log entry is for.

string job_id = 1;

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

clearNullRowCount()

public DataQualityScanRuleResult.Builder clearNullRowCount()

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

int64 null_row_count = 12;

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPassedRowCount()

public DataQualityScanRuleResult.Builder clearPassedRowCount()

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

int64 passed_row_count = 11;

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

clearResult()

public DataQualityScanRuleResult.Builder clearResult()

The result of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.Result result = 9;

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

clearRuleDimension()

public DataQualityScanRuleResult.Builder clearRuleDimension()

The dimension of the data quality rule.

string rule_dimension = 7;

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

clearRuleName()

public DataQualityScanRuleResult.Builder clearRuleName()

The name of the data quality rule.

string rule_name = 4;

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

clearRuleType()

public DataQualityScanRuleResult.Builder clearRuleType()

The type of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.RuleType rule_type = 5;

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

clearThresholdPercent()

public DataQualityScanRuleResult.Builder clearThresholdPercent()

The passing threshold ([0.0, 100.0]) of the data quality rule.

double threshold_percent = 8;

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

clone()

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

getColumn()

public String getColumn()

The column which this rule is evaluated against.

string column = 3;

Returns
Type Description
String

The column.

getColumnBytes()

public ByteString getColumnBytes()

The column which this rule is evaluated against.

string column = 3;

Returns
Type Description
ByteString

The bytes for column.

getDataSource()

public String getDataSource()

The data source of the data scan (e.g. BigQuery table name).

string data_source = 2;

Returns
Type Description
String

The dataSource.

getDataSourceBytes()

public ByteString getDataSourceBytes()

The data source of the data scan (e.g. BigQuery table name).

string data_source = 2;

Returns
Type Description
ByteString

The bytes for dataSource.

getDefaultInstanceForType()

public DataQualityScanRuleResult getDefaultInstanceForType()
Returns
Type Description
DataQualityScanRuleResult

getDescriptorForType()

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

getEvaluatedRowCount()

public long getEvaluatedRowCount()

The number of rows evaluated against the data quality rule. This field is only valid for rules of PER_ROW evaluation type.

int64 evaluated_row_count = 10;

Returns
Type Description
long

The evaluatedRowCount.

getEvalutionType()

public DataQualityScanRuleResult.EvaluationType getEvalutionType()

The evaluation type of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.EvaluationType evalution_type = 6;

Returns
Type Description
DataQualityScanRuleResult.EvaluationType

The evalutionType.

getEvalutionTypeValue()

public int getEvalutionTypeValue()

The evaluation type of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.EvaluationType evalution_type = 6;

Returns
Type Description
int

The enum numeric value on the wire for evalutionType.

getJobId()

public String getJobId()

Identifier of the specific data scan job this log entry is for.

string job_id = 1;

Returns
Type Description
String

The jobId.

getJobIdBytes()

public ByteString getJobIdBytes()

Identifier of the specific data scan job this log entry is for.

string job_id = 1;

Returns
Type Description
ByteString

The bytes for jobId.

getNullRowCount()

public long getNullRowCount()

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

int64 null_row_count = 12;

Returns
Type Description
long

The nullRowCount.

getPassedRowCount()

public long getPassedRowCount()

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

int64 passed_row_count = 11;

Returns
Type Description
long

The passedRowCount.

getResult()

public DataQualityScanRuleResult.Result getResult()

The result of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.Result result = 9;

Returns
Type Description
DataQualityScanRuleResult.Result

The result.

getResultValue()

public int getResultValue()

The result of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.Result result = 9;

Returns
Type Description
int

The enum numeric value on the wire for result.

getRuleDimension()

public String getRuleDimension()

The dimension of the data quality rule.

string rule_dimension = 7;

Returns
Type Description
String

The ruleDimension.

getRuleDimensionBytes()

public ByteString getRuleDimensionBytes()

The dimension of the data quality rule.

string rule_dimension = 7;

Returns
Type Description
ByteString

The bytes for ruleDimension.

getRuleName()

public String getRuleName()

The name of the data quality rule.

string rule_name = 4;

Returns
Type Description
String

The ruleName.

getRuleNameBytes()

public ByteString getRuleNameBytes()

The name of the data quality rule.

string rule_name = 4;

Returns
Type Description
ByteString

The bytes for ruleName.

getRuleType()

public DataQualityScanRuleResult.RuleType getRuleType()

The type of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.RuleType rule_type = 5;

Returns
Type Description
DataQualityScanRuleResult.RuleType

The ruleType.

getRuleTypeValue()

public int getRuleTypeValue()

The type of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.RuleType rule_type = 5;

Returns
Type Description
int

The enum numeric value on the wire for ruleType.

getThresholdPercent()

public double getThresholdPercent()

The passing threshold ([0.0, 100.0]) of the data quality rule.

double threshold_percent = 8;

Returns
Type Description
double

The thresholdPercent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DataQualityScanRuleResult other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setColumn(String value)

public DataQualityScanRuleResult.Builder setColumn(String value)

The column which this rule is evaluated against.

string column = 3;

Parameter
Name Description
value String

The column to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setColumnBytes(ByteString value)

public DataQualityScanRuleResult.Builder setColumnBytes(ByteString value)

The column which this rule is evaluated against.

string column = 3;

Parameter
Name Description
value ByteString

The bytes for column to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setDataSource(String value)

public DataQualityScanRuleResult.Builder setDataSource(String value)

The data source of the data scan (e.g. BigQuery table name).

string data_source = 2;

Parameter
Name Description
value String

The dataSource to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setDataSourceBytes(ByteString value)

public DataQualityScanRuleResult.Builder setDataSourceBytes(ByteString value)

The data source of the data scan (e.g. BigQuery table name).

string data_source = 2;

Parameter
Name Description
value ByteString

The bytes for dataSource to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setEvaluatedRowCount(long value)

public DataQualityScanRuleResult.Builder setEvaluatedRowCount(long value)

The number of rows evaluated against the data quality rule. This field is only valid for rules of PER_ROW evaluation type.

int64 evaluated_row_count = 10;

Parameter
Name Description
value long

The evaluatedRowCount to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setEvalutionType(DataQualityScanRuleResult.EvaluationType value)

public DataQualityScanRuleResult.Builder setEvalutionType(DataQualityScanRuleResult.EvaluationType value)

The evaluation type of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.EvaluationType evalution_type = 6;

Parameter
Name Description
value DataQualityScanRuleResult.EvaluationType

The evalutionType to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setEvalutionTypeValue(int value)

public DataQualityScanRuleResult.Builder setEvalutionTypeValue(int value)

The evaluation type of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.EvaluationType evalution_type = 6;

Parameter
Name Description
value int

The enum numeric value on the wire for evalutionType to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setJobId(String value)

public DataQualityScanRuleResult.Builder setJobId(String value)

Identifier of the specific data scan job this log entry is for.

string job_id = 1;

Parameter
Name Description
value String

The jobId to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setJobIdBytes(ByteString value)

public DataQualityScanRuleResult.Builder setJobIdBytes(ByteString value)

Identifier of the specific data scan job this log entry is for.

string job_id = 1;

Parameter
Name Description
value ByteString

The bytes for jobId to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setNullRowCount(long value)

public DataQualityScanRuleResult.Builder setNullRowCount(long value)

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

int64 null_row_count = 12;

Parameter
Name Description
value long

The nullRowCount to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setPassedRowCount(long value)

public DataQualityScanRuleResult.Builder setPassedRowCount(long value)

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

int64 passed_row_count = 11;

Parameter
Name Description
value long

The passedRowCount to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

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

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

setResult(DataQualityScanRuleResult.Result value)

public DataQualityScanRuleResult.Builder setResult(DataQualityScanRuleResult.Result value)

The result of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.Result result = 9;

Parameter
Name Description
value DataQualityScanRuleResult.Result

The result to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setResultValue(int value)

public DataQualityScanRuleResult.Builder setResultValue(int value)

The result of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.Result result = 9;

Parameter
Name Description
value int

The enum numeric value on the wire for result to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setRuleDimension(String value)

public DataQualityScanRuleResult.Builder setRuleDimension(String value)

The dimension of the data quality rule.

string rule_dimension = 7;

Parameter
Name Description
value String

The ruleDimension to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setRuleDimensionBytes(ByteString value)

public DataQualityScanRuleResult.Builder setRuleDimensionBytes(ByteString value)

The dimension of the data quality rule.

string rule_dimension = 7;

Parameter
Name Description
value ByteString

The bytes for ruleDimension to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setRuleName(String value)

public DataQualityScanRuleResult.Builder setRuleName(String value)

The name of the data quality rule.

string rule_name = 4;

Parameter
Name Description
value String

The ruleName to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setRuleNameBytes(ByteString value)

public DataQualityScanRuleResult.Builder setRuleNameBytes(ByteString value)

The name of the data quality rule.

string rule_name = 4;

Parameter
Name Description
value ByteString

The bytes for ruleName to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setRuleType(DataQualityScanRuleResult.RuleType value)

public DataQualityScanRuleResult.Builder setRuleType(DataQualityScanRuleResult.RuleType value)

The type of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.RuleType rule_type = 5;

Parameter
Name Description
value DataQualityScanRuleResult.RuleType

The ruleType to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setRuleTypeValue(int value)

public DataQualityScanRuleResult.Builder setRuleTypeValue(int value)

The type of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.RuleType rule_type = 5;

Parameter
Name Description
value int

The enum numeric value on the wire for ruleType to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setThresholdPercent(double value)

public DataQualityScanRuleResult.Builder setThresholdPercent(double value)

The passing threshold ([0.0, 100.0]) of the data quality rule.

double threshold_percent = 8;

Parameter
Name Description
value double

The thresholdPercent to set.

Returns
Type Description
DataQualityScanRuleResult.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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