Class DataScanEvent.DataQualityResult (1.31.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
TypeDescription
int

DIMENSION_PASSED_FIELD_NUMBER

public static final int DIMENSION_PASSED_FIELD_NUMBER
Field Value
TypeDescription
int

DIMENSION_SCORE_FIELD_NUMBER

public static final int DIMENSION_SCORE_FIELD_NUMBER
Field Value
TypeDescription
int

PASSED_FIELD_NUMBER

public static final int PASSED_FIELD_NUMBER
Field Value
TypeDescription
int

ROW_COUNT_FIELD_NUMBER

public static final int ROW_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

SCORE_FIELD_NUMBER

public static final int SCORE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DataScanEvent.DataQualityResult getDefaultInstance()
Returns
TypeDescription
DataScanEvent.DataQualityResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static DataScanEvent.DataQualityResult.Builder newBuilder()
Returns
TypeDescription
DataScanEvent.DataQualityResult.Builder

newBuilder(DataScanEvent.DataQualityResult prototype)

public static DataScanEvent.DataQualityResult.Builder newBuilder(DataScanEvent.DataQualityResult prototype)
Parameter
NameDescription
prototypeDataScanEvent.DataQualityResult
Returns
TypeDescription
DataScanEvent.DataQualityResult.Builder

parseDelimitedFrom(InputStream input)

public static DataScanEvent.DataQualityResult parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DataScanEvent.DataQualityResult
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent.DataQualityResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataScanEvent.DataQualityResult
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DataScanEvent.DataQualityResult parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DataScanEvent.DataQualityResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent.DataQualityResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataScanEvent.DataQualityResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataScanEvent.DataQualityResult parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DataScanEvent.DataQualityResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent.DataQualityResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataScanEvent.DataQualityResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataScanEvent.DataQualityResult parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DataScanEvent.DataQualityResult
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent.DataQualityResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataScanEvent.DataQualityResult
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DataScanEvent.DataQualityResult parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DataScanEvent.DataQualityResult
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent.DataQualityResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataScanEvent.DataQualityResult
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DataScanEvent.DataQualityResult parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DataScanEvent.DataQualityResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent.DataQualityResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataScanEvent.DataQualityResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DataScanEvent.DataQualityResult> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getColumnScore() (deprecated)

public Map<String,Float> getColumnScore()

Use #getColumnScoreMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValuefloat
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
float

getDefaultInstanceForType()

public DataScanEvent.DataQualityResult getDefaultInstanceForType()
Returns
TypeDescription
DataScanEvent.DataQualityResult

getDimensionPassed() (deprecated)

public Map<String,Boolean> getDimensionPassed()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueboolean
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

getDimensionScore() (deprecated)

public Map<String,Float> getDimensionScore()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValuefloat
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
float

getParserForType()

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

getPassed()

public boolean getPassed()

Whether the data quality result was pass or not.

bool passed = 2;

Returns
TypeDescription
boolean

The passed.

getRowCount()

public long getRowCount()

The count of rows processed in the data scan job.

int64 row_count = 1;

Returns
TypeDescription
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
TypeDescription
float

The score.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DataScanEvent.DataQualityResult.Builder newBuilderForType()
Returns
TypeDescription
DataScanEvent.DataQualityResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DataScanEvent.DataQualityResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DataScanEvent.DataQualityResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DataScanEvent.DataQualityResult.Builder toBuilder()
Returns
TypeDescription
DataScanEvent.DataQualityResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException