Class DataQualityRuleResult (1.50.0) 

public final class DataQualityRuleResult extends GeneratedMessageV3 implements DataQualityRuleResultOrBuilder

DataQualityRuleResult provides a more detailed, per-rule view of the results.

Protobuf type google.cloud.dataplex.v1.DataQualityRuleResult

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DataQualityRuleResult

Static Fields

ASSERTION_ROW_COUNT_FIELD_NUMBER

public static final int ASSERTION_ROW_COUNT_FIELD_NUMBER
Field Value
Type Description
int

EVALUATED_COUNT_FIELD_NUMBER

public static final int EVALUATED_COUNT_FIELD_NUMBER
Field Value
Type Description
int

FAILING_ROWS_QUERY_FIELD_NUMBER

public static final int FAILING_ROWS_QUERY_FIELD_NUMBER
Field Value
Type Description
int

NULL_COUNT_FIELD_NUMBER

public static final int NULL_COUNT_FIELD_NUMBER
Field Value
Type Description
int

PASSED_COUNT_FIELD_NUMBER

public static final int PASSED_COUNT_FIELD_NUMBER
Field Value
Type Description
int

PASSED_FIELD_NUMBER

public static final int PASSED_FIELD_NUMBER
Field Value
Type Description
int

PASS_RATIO_FIELD_NUMBER

public static final int PASS_RATIO_FIELD_NUMBER
Field Value
Type Description
int

RULE_FIELD_NUMBER

public static final int RULE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DataQualityRuleResult getDefaultInstance()
Returns
Type Description
DataQualityRuleResult

getDescriptor()

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

newBuilder()

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

newBuilder(DataQualityRuleResult prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAssertionRowCount()

public long getAssertionRowCount()

Output only. The number of rows returned by the SQL statement in a SQL assertion rule.

This field is only valid for SQL assertion rules.

int64 assertion_row_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The assertionRowCount.

getDefaultInstanceForType()

public DataQualityRuleResult getDefaultInstanceForType()
Returns
Type Description
DataQualityRuleResult

getEvaluatedCount()

public long getEvaluatedCount()

The number of rows a rule was evaluated against.

This field is only valid for row-level type rules.

Evaluated count can be configured to either

  • include all rows (default) - with null rows automatically failing rule evaluation, or
  • exclude null rows from the evaluated_count, by setting ignore_nulls = true.

int64 evaluated_count = 9;

Returns
Type Description
long

The evaluatedCount.

getFailingRowsQuery()

public String getFailingRowsQuery()

The query to find rows that did not pass this rule.

This field is only valid for row-level type rules.

string failing_rows_query = 10;

Returns
Type Description
String

The failingRowsQuery.

getFailingRowsQueryBytes()

public ByteString getFailingRowsQueryBytes()

The query to find rows that did not pass this rule.

This field is only valid for row-level type rules.

string failing_rows_query = 10;

Returns
Type Description
ByteString

The bytes for failingRowsQuery.

getNullCount()

public long getNullCount()

The number of rows with null values in the specified column.

int64 null_count = 5;

Returns
Type Description
long

The nullCount.

getParserForType()

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

getPassRatio()

public double getPassRatio()

The ratio of passed_count / evaluated_count.

This field is only valid for row-level type rules.

double pass_ratio = 6;

Returns
Type Description
double

The passRatio.

getPassed()

public boolean getPassed()

Whether the rule passed or failed.

bool passed = 7;

Returns
Type Description
boolean

The passed.

getPassedCount()

public long getPassedCount()

The number of rows which passed a rule evaluation.

This field is only valid for row-level type rules.

int64 passed_count = 8;

Returns
Type Description
long

The passedCount.

getRule()

public DataQualityRule getRule()

The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1;

Returns
Type Description
DataQualityRule

The rule.

getRuleOrBuilder()

public DataQualityRuleOrBuilder getRuleOrBuilder()

The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1;

Returns
Type Description
DataQualityRuleOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasRule()

public boolean hasRule()

The rule specified in the DataQualitySpec, as is.

.google.cloud.dataplex.v1.DataQualityRule rule = 1;

Returns
Type Description
boolean

Whether the rule 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 DataQualityRuleResult.Builder newBuilderForType()
Returns
Type Description
DataQualityRuleResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public DataQualityRuleResult.Builder toBuilder()
Returns
Type Description
DataQualityRuleResult.Builder

writeTo(CodedOutputStream output)

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