Class DataScanEvent.DataQualityResult (1.40.0)

public static final class DataScanEvent.DataQualityResult extends GeneratedMessageV3 implements DataScanEvent.DataQualityResultOrBuilder

Data quality result for data scan job.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DataScanEvent.DataQualityResult

Static Fields

COLUMN_SCORE_FIELD_NUMBER

public static final int COLUMN_SCORE_FIELD_NUMBER
Field Value
Type Description
int

DIMENSION_PASSED_FIELD_NUMBER

public static final int DIMENSION_PASSED_FIELD_NUMBER
Field Value
Type Description
int

DIMENSION_SCORE_FIELD_NUMBER

public static final int DIMENSION_SCORE_FIELD_NUMBER
Field Value
Type Description
int

PASSED_FIELD_NUMBER

public static final int PASSED_FIELD_NUMBER
Field Value
Type Description
int

ROW_COUNT_FIELD_NUMBER

public static final int ROW_COUNT_FIELD_NUMBER
Field Value
Type Description
int

SCORE_FIELD_NUMBER

public static final int SCORE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DataScanEvent.DataQualityResult getDefaultInstance()
Returns
Type Description
DataScanEvent.DataQualityResult

getDescriptor()

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

newBuilder()

public static DataScanEvent.DataQualityResult.Builder newBuilder()
Returns
Type Description
DataScanEvent.DataQualityResult.Builder

newBuilder(DataScanEvent.DataQualityResult prototype)

public static DataScanEvent.DataQualityResult.Builder newBuilder(DataScanEvent.DataQualityResult prototype)
Parameter
Name Description
prototype DataScanEvent.DataQualityResult
Returns
Type Description
DataScanEvent.DataQualityResult.Builder

parseDelimitedFrom(InputStream input)

public static DataScanEvent.DataQualityResult parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataScanEvent.DataQualityResult
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent.DataQualityResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataScanEvent.DataQualityResult
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DataScanEvent.DataQualityResult parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DataScanEvent.DataQualityResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent.DataQualityResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataScanEvent.DataQualityResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataScanEvent.DataQualityResult parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DataScanEvent.DataQualityResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent.DataQualityResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataScanEvent.DataQualityResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataScanEvent.DataQualityResult parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DataScanEvent.DataQualityResult
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent.DataQualityResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataScanEvent.DataQualityResult
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DataScanEvent.DataQualityResult parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataScanEvent.DataQualityResult
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent.DataQualityResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataScanEvent.DataQualityResult
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DataScanEvent.DataQualityResult parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DataScanEvent.DataQualityResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent.DataQualityResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataScanEvent.DataQualityResult
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DataScanEvent.DataQualityResult> parser()
Returns
Type Description
Parser<DataQualityResult>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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

getParserForType()

public Parser<DataScanEvent.DataQualityResult> getParserForType()
Returns
Type Description
Parser<DataQualityResult>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DataScanEvent.DataQualityResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DataScanEvent.DataQualityResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException