Class DataQualityRuleResult (1.21.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

Static Fields

EVALUATED_COUNT_FIELD_NUMBER

public static final int EVALUATED_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

FAILING_ROWS_QUERY_FIELD_NUMBER

public static final int FAILING_ROWS_QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

NULL_COUNT_FIELD_NUMBER

public static final int NULL_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

PASSED_COUNT_FIELD_NUMBER

public static final int PASSED_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

PASSED_FIELD_NUMBER

public static final int PASSED_FIELD_NUMBER
Field Value
TypeDescription
int

PASS_RATIO_FIELD_NUMBER

public static final int PASS_RATIO_FIELD_NUMBER
Field Value
TypeDescription
int

RULE_FIELD_NUMBER

public static final int RULE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DataQualityRuleResult getDefaultInstance()
Returns
TypeDescription
DataQualityRuleResult

getDescriptor()

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

newBuilder()

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

newBuilder(DataQualityRuleResult prototype)

public static DataQualityRuleResult.Builder newBuilder(DataQualityRuleResult prototype)
Parameter
NameDescription
prototypeDataQualityRuleResult
Returns
TypeDescription
DataQualityRuleResult.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public DataQualityRuleResult getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
long

The nullCount.

getParserForType()

public Parser<DataQualityRuleResult> getParserForType()
Returns
TypeDescription
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
TypeDescription
double

The passRatio.

getPassed()

public boolean getPassed()

Whether the rule passed or failed.

bool passed = 7;

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

The passedCount.

getRule()

public DataQualityRule getRule()

The rule specified in the DataQualitySpec, as is.

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

Returns
TypeDescription
DataQualityRule

The rule.

getRuleOrBuilder()

public DataQualityRuleOrBuilder getRuleOrBuilder()

The rule specified in the DataQualitySpec, as is.

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

Returns
TypeDescription
DataQualityRuleOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasRule()

public boolean hasRule()

The rule specified in the DataQualitySpec, as is.

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

Returns
TypeDescription
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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