Class DataQualityResult (1.45.0)

public final class DataQualityResult extends GeneratedMessageV3 implements DataQualityResultOrBuilder

The output of a DataQualityScan.

Protobuf type google.cloud.dataplex.v1.DataQualityResult

Static Fields

COLUMNS_FIELD_NUMBER

public static final int COLUMNS_FIELD_NUMBER
Field Value
Type Description
int

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER
Field Value
Type Description
int

PASSED_FIELD_NUMBER

public static final int PASSED_FIELD_NUMBER
Field Value
Type Description
int

POST_SCAN_ACTIONS_RESULT_FIELD_NUMBER

public static final int POST_SCAN_ACTIONS_RESULT_FIELD_NUMBER
Field Value
Type Description
int

ROW_COUNT_FIELD_NUMBER

public static final int ROW_COUNT_FIELD_NUMBER
Field Value
Type Description
int

RULES_FIELD_NUMBER

public static final int RULES_FIELD_NUMBER
Field Value
Type Description
int

SCANNED_DATA_FIELD_NUMBER

public static final int SCANNED_DATA_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 DataQualityResult getDefaultInstance()
Returns
Type Description
DataQualityResult

getDescriptor()

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

newBuilder()

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

newBuilder(DataQualityResult prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getColumns(int index)

public DataQualityColumnResult getColumns(int index)

Output only. A list of results at the column level.

A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the 'column' field set to it.

repeated .google.cloud.dataplex.v1.DataQualityColumnResult columns = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DataQualityColumnResult

getColumnsCount()

public int getColumnsCount()

Output only. A list of results at the column level.

A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the 'column' field set to it.

repeated .google.cloud.dataplex.v1.DataQualityColumnResult columns = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getColumnsList()

public List<DataQualityColumnResult> getColumnsList()

Output only. A list of results at the column level.

A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the 'column' field set to it.

repeated .google.cloud.dataplex.v1.DataQualityColumnResult columns = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<DataQualityColumnResult>

getColumnsOrBuilder(int index)

public DataQualityColumnResultOrBuilder getColumnsOrBuilder(int index)

Output only. A list of results at the column level.

A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the 'column' field set to it.

repeated .google.cloud.dataplex.v1.DataQualityColumnResult columns = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DataQualityColumnResultOrBuilder

getColumnsOrBuilderList()

public List<? extends DataQualityColumnResultOrBuilder> getColumnsOrBuilderList()

Output only. A list of results at the column level.

A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the 'column' field set to it.

repeated .google.cloud.dataplex.v1.DataQualityColumnResult columns = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.dataplex.v1.DataQualityColumnResultOrBuilder>

getDefaultInstanceForType()

public DataQualityResult getDefaultInstanceForType()
Returns
Type Description
DataQualityResult

getDimensions(int index)

public DataQualityDimensionResult getDimensions(int index)

A list of results at the dimension level.

A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it.

repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;

Parameter
Name Description
index int
Returns
Type Description
DataQualityDimensionResult

getDimensionsCount()

public int getDimensionsCount()

A list of results at the dimension level.

A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it.

repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;

Returns
Type Description
int

getDimensionsList()

public List<DataQualityDimensionResult> getDimensionsList()

A list of results at the dimension level.

A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it.

repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;

Returns
Type Description
List<DataQualityDimensionResult>

getDimensionsOrBuilder(int index)

public DataQualityDimensionResultOrBuilder getDimensionsOrBuilder(int index)

A list of results at the dimension level.

A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it.

repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;

Parameter
Name Description
index int
Returns
Type Description
DataQualityDimensionResultOrBuilder

getDimensionsOrBuilderList()

public List<? extends DataQualityDimensionResultOrBuilder> getDimensionsOrBuilderList()

A list of results at the dimension level.

A dimension will have a corresponding DataQualityDimensionResult if and only if there is at least one rule with the 'dimension' field set to it.

repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;

Returns
Type Description
List<? extends com.google.cloud.dataplex.v1.DataQualityDimensionResultOrBuilder>

getParserForType()

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

getPassed()

public boolean getPassed()

Overall data quality result -- true if all rules passed.

bool passed = 5;

Returns
Type Description
boolean

The passed.

getPostScanActionsResult()

public DataQualityResult.PostScanActionsResult getPostScanActionsResult()

Output only. The result of post scan actions.

.google.cloud.dataplex.v1.DataQualityResult.PostScanActionsResult post_scan_actions_result = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityResult.PostScanActionsResult

The postScanActionsResult.

getPostScanActionsResultOrBuilder()

public DataQualityResult.PostScanActionsResultOrBuilder getPostScanActionsResultOrBuilder()

Output only. The result of post scan actions.

.google.cloud.dataplex.v1.DataQualityResult.PostScanActionsResult post_scan_actions_result = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityResult.PostScanActionsResultOrBuilder

getRowCount()

public long getRowCount()

The count of rows processed.

int64 row_count = 4;

Returns
Type Description
long

The rowCount.

getRules(int index)

public DataQualityRuleResult getRules(int index)

A list of all the rules in a job, and their results.

repeated .google.cloud.dataplex.v1.DataQualityRuleResult rules = 3;

Parameter
Name Description
index int
Returns
Type Description
DataQualityRuleResult

getRulesCount()

public int getRulesCount()

A list of all the rules in a job, and their results.

repeated .google.cloud.dataplex.v1.DataQualityRuleResult rules = 3;

Returns
Type Description
int

getRulesList()

public List<DataQualityRuleResult> getRulesList()

A list of all the rules in a job, and their results.

repeated .google.cloud.dataplex.v1.DataQualityRuleResult rules = 3;

Returns
Type Description
List<DataQualityRuleResult>

getRulesOrBuilder(int index)

public DataQualityRuleResultOrBuilder getRulesOrBuilder(int index)

A list of all the rules in a job, and their results.

repeated .google.cloud.dataplex.v1.DataQualityRuleResult rules = 3;

Parameter
Name Description
index int
Returns
Type Description
DataQualityRuleResultOrBuilder

getRulesOrBuilderList()

public List<? extends DataQualityRuleResultOrBuilder> getRulesOrBuilderList()

A list of all the rules in a job, and their results.

repeated .google.cloud.dataplex.v1.DataQualityRuleResult rules = 3;

Returns
Type Description
List<? extends com.google.cloud.dataplex.v1.DataQualityRuleResultOrBuilder>

getScannedData()

public ScannedData getScannedData()

The data scanned for this result.

.google.cloud.dataplex.v1.ScannedData scanned_data = 7;

Returns
Type Description
ScannedData

The scannedData.

getScannedDataOrBuilder()

public ScannedDataOrBuilder getScannedDataOrBuilder()

The data scanned for this result.

.google.cloud.dataplex.v1.ScannedData scanned_data = 7;

Returns
Type Description
ScannedDataOrBuilder

getScore()

public float getScore()

Output only. The overall data quality score.

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

optional float score = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
float

The score.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasPostScanActionsResult()

public boolean hasPostScanActionsResult()

Output only. The result of post scan actions.

.google.cloud.dataplex.v1.DataQualityResult.PostScanActionsResult post_scan_actions_result = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the postScanActionsResult field is set.

hasScannedData()

public boolean hasScannedData()

The data scanned for this result.

.google.cloud.dataplex.v1.ScannedData scanned_data = 7;

Returns
Type Description
boolean

Whether the scannedData field is set.

hasScore()

public boolean hasScore()

Output only. The overall data quality score.

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

optional float score = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the score field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DataQualityResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
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 DataQualityResult.Builder toBuilder()
Returns
Type Description
DataQualityResult.Builder

writeTo(CodedOutputStream output)

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