Class DataScanEvent.DataQualityResult.Builder (1.53.0)

public static final class DataScanEvent.DataQualityResult.Builder extends GeneratedMessageV3.Builder<DataScanEvent.DataQualityResult.Builder> implements DataScanEvent.DataQualityResultOrBuilder

Data quality result for data scan job.

Protobuf type google.cloud.dataplex.v1.DataScanEvent.DataQualityResult

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public DataScanEvent.DataQualityResult build()
Returns
Type Description
DataScanEvent.DataQualityResult

buildPartial()

public DataScanEvent.DataQualityResult buildPartial()
Returns
Type Description
DataScanEvent.DataQualityResult

clear()

public DataScanEvent.DataQualityResult.Builder clear()
Returns
Type Description
DataScanEvent.DataQualityResult.Builder
Overrides

clearColumnScore()

public DataScanEvent.DataQualityResult.Builder clearColumnScore()
Returns
Type Description
DataScanEvent.DataQualityResult.Builder

clearDimensionPassed()

public DataScanEvent.DataQualityResult.Builder clearDimensionPassed()
Returns
Type Description
DataScanEvent.DataQualityResult.Builder

clearDimensionScore()

public DataScanEvent.DataQualityResult.Builder clearDimensionScore()
Returns
Type Description
DataScanEvent.DataQualityResult.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPassed()

public DataScanEvent.DataQualityResult.Builder clearPassed()

Whether the data quality result was pass or not.

bool passed = 2;

Returns
Type Description
DataScanEvent.DataQualityResult.Builder

This builder for chaining.

clearRowCount()

public DataScanEvent.DataQualityResult.Builder clearRowCount()

The count of rows processed in the data scan job.

int64 row_count = 1;

Returns
Type Description
DataScanEvent.DataQualityResult.Builder

This builder for chaining.

clearScore()

public DataScanEvent.DataQualityResult.Builder clearScore()

The table-level data quality score for the data scan job.

The data quality score ranges between [0, 100] (up to two decimal points).

float score = 4;

Returns
Type Description
DataScanEvent.DataQualityResult.Builder

This builder for chaining.

clone()

public DataScanEvent.DataQualityResult.Builder clone()
Returns
Type Description
DataScanEvent.DataQualityResult.Builder
Overrides

containsColumnScore(String key)

public boolean containsColumnScore(String key)

The score of each column scanned in the data scan job. The key of the map is the name of the column. The value is the data quality score for the column.

The score ranges between [0, 100] (up to two decimal points).

map<string, float> column_score = 6;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsDimensionPassed(String key)

public boolean containsDimensionPassed(String key)

The result of each dimension for data quality result. The key of the map is the name of the dimension. The value is the bool value depicting whether the dimension result was pass or not.

map<string, bool> dimension_passed = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsDimensionScore(String key)

public boolean containsDimensionScore(String key)

The score of each dimension for data quality result. The key of the map is the name of the dimension. The value is the data quality score for the dimension.

The score ranges between [0, 100] (up to two decimal points).

map<string, float> dimension_score = 5;

Parameter
Name Description
key String
Returns
Type Description
boolean

getColumnScore() (deprecated)

public Map<String,Float> getColumnScore()

Use #getColumnScoreMap() instead.

Returns
Type Description
Map<String,java.lang.Float>

getColumnScoreCount()

public int getColumnScoreCount()

The score of each column scanned in the data scan job. The key of the map is the name of the column. The value is the data quality score for the column.

The score ranges between [0, 100] (up to two decimal points).

map<string, float> column_score = 6;

Returns
Type Description
int

getColumnScoreMap()

public Map<String,Float> getColumnScoreMap()

The score of each column scanned in the data scan job. The key of the map is the name of the column. The value is the data quality score for the column.

The score ranges between [0, 100] (up to two decimal points).

map<string, float> column_score = 6;

Returns
Type Description
Map<String,java.lang.Float>

getColumnScoreOrDefault(String key, float defaultValue)

public float getColumnScoreOrDefault(String key, float defaultValue)

The score of each column scanned in the data scan job. The key of the map is the name of the column. The value is the data quality score for the column.

The score ranges between [0, 100] (up to two decimal points).

map<string, float> column_score = 6;

Parameters
Name Description
key String
defaultValue float
Returns
Type Description
float

getColumnScoreOrThrow(String key)

public float getColumnScoreOrThrow(String key)

The score of each column scanned in the data scan job. The key of the map is the name of the column. The value is the data quality score for the column.

The score ranges between [0, 100] (up to two decimal points).

map<string, float> column_score = 6;

Parameter
Name Description
key String
Returns
Type Description
float

getDefaultInstanceForType()

public DataScanEvent.DataQualityResult getDefaultInstanceForType()
Returns
Type Description
DataScanEvent.DataQualityResult

getDescriptorForType()

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

getDimensionPassed() (deprecated)

public Map<String,Boolean> getDimensionPassed()
Returns
Type Description
Map<String,java.lang.Boolean>

getDimensionPassedCount()

public int getDimensionPassedCount()

The result of each dimension for data quality result. The key of the map is the name of the dimension. The value is the bool value depicting whether the dimension result was pass or not.

map<string, bool> dimension_passed = 3;

Returns
Type Description
int

getDimensionPassedMap()

public Map<String,Boolean> getDimensionPassedMap()

The result of each dimension for data quality result. The key of the map is the name of the dimension. The value is the bool value depicting whether the dimension result was pass or not.

map<string, bool> dimension_passed = 3;

Returns
Type Description
Map<String,java.lang.Boolean>

getDimensionPassedOrDefault(String key, boolean defaultValue)

public boolean getDimensionPassedOrDefault(String key, boolean defaultValue)

The result of each dimension for data quality result. The key of the map is the name of the dimension. The value is the bool value depicting whether the dimension result was pass or not.

map<string, bool> dimension_passed = 3;

Parameters
Name Description
key String
defaultValue boolean
Returns
Type Description
boolean

getDimensionPassedOrThrow(String key)

public boolean getDimensionPassedOrThrow(String key)

The result of each dimension for data quality result. The key of the map is the name of the dimension. The value is the bool value depicting whether the dimension result was pass or not.

map<string, bool> dimension_passed = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

getDimensionScore() (deprecated)

public Map<String,Float> getDimensionScore()
Returns
Type Description
Map<String,java.lang.Float>

getDimensionScoreCount()

public int getDimensionScoreCount()

The score of each dimension for data quality result. The key of the map is the name of the dimension. The value is the data quality score for the dimension.

The score ranges between [0, 100] (up to two decimal points).

map<string, float> dimension_score = 5;

Returns
Type Description
int

getDimensionScoreMap()

public Map<String,Float> getDimensionScoreMap()

The score of each dimension for data quality result. The key of the map is the name of the dimension. The value is the data quality score for the dimension.

The score ranges between [0, 100] (up to two decimal points).

map<string, float> dimension_score = 5;

Returns
Type Description
Map<String,java.lang.Float>

getDimensionScoreOrDefault(String key, float defaultValue)

public float getDimensionScoreOrDefault(String key, float defaultValue)

The score of each dimension for data quality result. The key of the map is the name of the dimension. The value is the data quality score for the dimension.

The score ranges between [0, 100] (up to two decimal points).

map<string, float> dimension_score = 5;

Parameters
Name Description
key String
defaultValue float
Returns
Type Description
float

getDimensionScoreOrThrow(String key)

public float getDimensionScoreOrThrow(String key)

The score of each dimension for data quality result. The key of the map is the name of the dimension. The value is the data quality score for the dimension.

The score ranges between [0, 100] (up to two decimal points).

map<string, float> dimension_score = 5;

Parameter
Name Description
key String
Returns
Type Description
float

getMutableColumnScore() (deprecated)

public Map<String,Float> getMutableColumnScore()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,java.lang.Float>

getMutableDimensionPassed() (deprecated)

public Map<String,Boolean> getMutableDimensionPassed()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,java.lang.Boolean>

getMutableDimensionScore() (deprecated)

public Map<String,Float> getMutableDimensionScore()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,java.lang.Float>

getPassed()

public boolean getPassed()

Whether the data quality result was pass or not.

bool passed = 2;

Returns
Type Description
boolean

The passed.

getRowCount()

public long getRowCount()

The count of rows processed in the data scan job.

int64 row_count = 1;

Returns
Type Description
long

The rowCount.

getScore()

public float getScore()

The table-level data quality score for the data scan job.

The data quality score ranges between [0, 100] (up to two decimal points).

float score = 4;

Returns
Type Description
float

The score.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DataScanEvent.DataQualityResult other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllColumnScore(Map<String,Float> values)

public DataScanEvent.DataQualityResult.Builder putAllColumnScore(Map<String,Float> values)

The score of each column scanned in the data scan job. The key of the map is the name of the column. The value is the data quality score for the column.

The score ranges between [0, 100] (up to two decimal points).

map<string, float> column_score = 6;

Parameter
Name Description
values Map<String,java.lang.Float>
Returns
Type Description
DataScanEvent.DataQualityResult.Builder

putAllDimensionPassed(Map<String,Boolean> values)

public DataScanEvent.DataQualityResult.Builder putAllDimensionPassed(Map<String,Boolean> values)

The result of each dimension for data quality result. The key of the map is the name of the dimension. The value is the bool value depicting whether the dimension result was pass or not.

map<string, bool> dimension_passed = 3;

Parameter
Name Description
values Map<String,java.lang.Boolean>
Returns
Type Description
DataScanEvent.DataQualityResult.Builder

putAllDimensionScore(Map<String,Float> values)

public DataScanEvent.DataQualityResult.Builder putAllDimensionScore(Map<String,Float> values)

The score of each dimension for data quality result. The key of the map is the name of the dimension. The value is the data quality score for the dimension.

The score ranges between [0, 100] (up to two decimal points).

map<string, float> dimension_score = 5;

Parameter
Name Description
values Map<String,java.lang.Float>
Returns
Type Description
DataScanEvent.DataQualityResult.Builder

putColumnScore(String key, float value)

public DataScanEvent.DataQualityResult.Builder putColumnScore(String key, float value)

The score of each column scanned in the data scan job. The key of the map is the name of the column. The value is the data quality score for the column.

The score ranges between [0, 100] (up to two decimal points).

map<string, float> column_score = 6;

Parameters
Name Description
key String
value float
Returns
Type Description
DataScanEvent.DataQualityResult.Builder

putDimensionPassed(String key, boolean value)

public DataScanEvent.DataQualityResult.Builder putDimensionPassed(String key, boolean value)

The result of each dimension for data quality result. The key of the map is the name of the dimension. The value is the bool value depicting whether the dimension result was pass or not.

map<string, bool> dimension_passed = 3;

Parameters
Name Description
key String
value boolean
Returns
Type Description
DataScanEvent.DataQualityResult.Builder

putDimensionScore(String key, float value)

public DataScanEvent.DataQualityResult.Builder putDimensionScore(String key, float value)

The score of each dimension for data quality result. The key of the map is the name of the dimension. The value is the data quality score for the dimension.

The score ranges between [0, 100] (up to two decimal points).

map<string, float> dimension_score = 5;

Parameters
Name Description
key String
value float
Returns
Type Description
DataScanEvent.DataQualityResult.Builder

removeColumnScore(String key)

public DataScanEvent.DataQualityResult.Builder removeColumnScore(String key)

The score of each column scanned in the data scan job. The key of the map is the name of the column. The value is the data quality score for the column.

The score ranges between [0, 100] (up to two decimal points).

map<string, float> column_score = 6;

Parameter
Name Description
key String
Returns
Type Description
DataScanEvent.DataQualityResult.Builder

removeDimensionPassed(String key)

public DataScanEvent.DataQualityResult.Builder removeDimensionPassed(String key)

The result of each dimension for data quality result. The key of the map is the name of the dimension. The value is the bool value depicting whether the dimension result was pass or not.

map<string, bool> dimension_passed = 3;

Parameter
Name Description
key String
Returns
Type Description
DataScanEvent.DataQualityResult.Builder

removeDimensionScore(String key)

public DataScanEvent.DataQualityResult.Builder removeDimensionScore(String key)

The score of each dimension for data quality result. The key of the map is the name of the dimension. The value is the data quality score for the dimension.

The score ranges between [0, 100] (up to two decimal points).

map<string, float> dimension_score = 5;

Parameter
Name Description
key String
Returns
Type Description
DataScanEvent.DataQualityResult.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setPassed(boolean value)

public DataScanEvent.DataQualityResult.Builder setPassed(boolean value)

Whether the data quality result was pass or not.

bool passed = 2;

Parameter
Name Description
value boolean

The passed to set.

Returns
Type Description
DataScanEvent.DataQualityResult.Builder

This builder for chaining.

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

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

setRowCount(long value)

public DataScanEvent.DataQualityResult.Builder setRowCount(long value)

The count of rows processed in the data scan job.

int64 row_count = 1;

Parameter
Name Description
value long

The rowCount to set.

Returns
Type Description
DataScanEvent.DataQualityResult.Builder

This builder for chaining.

setScore(float value)

public DataScanEvent.DataQualityResult.Builder setScore(float value)

The table-level data quality score for the data scan job.

The data quality score ranges between [0, 100] (up to two decimal points).

float score = 4;

Parameter
Name Description
value float

The score to set.

Returns
Type Description
DataScanEvent.DataQualityResult.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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