Interface DataScanEvent.DataQualityResultOrBuilder (1.30.0)

public static interface DataScanEvent.DataQualityResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsColumnScore(String key)

public abstract 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 abstract 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 abstract 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 abstract Map<String,Float> getColumnScore()

Use #getColumnScoreMap() instead.

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

getColumnScoreCount()

public abstract 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 abstract 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 abstract 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 abstract 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`

getDimensionPassed() (deprecated)

public abstract Map<String,Boolean> getDimensionPassed()

Use #getDimensionPassedMap() instead.

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

getDimensionPassedCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract Map<String,Float> getDimensionScore()

Use #getDimensionScoreMap() instead.

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

getDimensionScoreCount()

public abstract 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 abstract 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 abstract 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 abstract 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`

getPassed()

public abstract boolean getPassed()

Whether the data quality result was pass or not.

bool passed = 2;

Returns
Type	Description
`boolean`	The passed.

getRowCount()

public abstract long getRowCount()

The count of rows processed in the data scan job.

int64 row_count = 1;

Returns
Type	Description
`long`	The rowCount.

getScore()

public abstract 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.