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

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER
Field Value
TypeDescription
int

PASSED_FIELD_NUMBER

public static final int PASSED_FIELD_NUMBER
Field Value
TypeDescription
int

POST_SCAN_ACTIONS_RESULT_FIELD_NUMBER

public static final int POST_SCAN_ACTIONS_RESULT_FIELD_NUMBER
Field Value
TypeDescription
int

ROW_COUNT_FIELD_NUMBER

public static final int ROW_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

RULES_FIELD_NUMBER

public static final int RULES_FIELD_NUMBER
Field Value
TypeDescription
int

SCANNED_DATA_FIELD_NUMBER

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

getDescriptor()

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

newBuilder()

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

newBuilder(DataQualityResult prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<DataQualityResult> parser()
Returns
TypeDescription
Parser<DataQualityResult>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.dataplex.v1.DataQualityColumnResultOrBuilder>

getDefaultInstanceForType()

public DataQualityResult getDefaultInstanceForType()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.dataplex.v1.DataQualityDimensionResultOrBuilder>

getParserForType()

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

getPassed()

public boolean getPassed()

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

bool passed = 5;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
DataQualityResult.PostScanActionsResultOrBuilder

getRowCount()

public long getRowCount()

The count of rows processed.

int64 row_count = 4;

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ScannedData

The scannedData.

getScannedDataOrBuilder()

public ScannedDataOrBuilder getScannedDataOrBuilder()

The data scanned for this result.

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

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

The score.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the score field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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