Class DataQualityScanRuleResult (1.21.0)

public final class DataQualityScanRuleResult extends GeneratedMessageV3 implements DataQualityScanRuleResultOrBuilder

Information about the result of a data quality rule for data quality scan. The monitored resource is 'DataScan'.

Protobuf type google.cloud.dataplex.v1.DataQualityScanRuleResult

Static Fields

COLUMN_FIELD_NUMBER

public static final int COLUMN_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_SOURCE_FIELD_NUMBER

public static final int DATA_SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

EVALUATED_ROW_COUNT_FIELD_NUMBER

public static final int EVALUATED_ROW_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

EVALUTION_TYPE_FIELD_NUMBER

public static final int EVALUTION_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

JOB_ID_FIELD_NUMBER

public static final int JOB_ID_FIELD_NUMBER
Field Value
TypeDescription
int

NULL_ROW_COUNT_FIELD_NUMBER

public static final int NULL_ROW_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

PASSED_ROW_COUNT_FIELD_NUMBER

public static final int PASSED_ROW_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

RESULT_FIELD_NUMBER

public static final int RESULT_FIELD_NUMBER
Field Value
TypeDescription
int

RULE_DIMENSION_FIELD_NUMBER

public static final int RULE_DIMENSION_FIELD_NUMBER
Field Value
TypeDescription
int

RULE_NAME_FIELD_NUMBER

public static final int RULE_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RULE_TYPE_FIELD_NUMBER

public static final int RULE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

THRESHOLD_PERCENT_FIELD_NUMBER

public static final int THRESHOLD_PERCENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DataQualityScanRuleResult getDefaultInstance()
Returns
TypeDescription
DataQualityScanRuleResult

getDescriptor()

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

newBuilder()

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

newBuilder(DataQualityScanRuleResult prototype)

public static DataQualityScanRuleResult.Builder newBuilder(DataQualityScanRuleResult prototype)
Parameter
NameDescription
prototypeDataQualityScanRuleResult
Returns
TypeDescription
DataQualityScanRuleResult.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getColumn()

public String getColumn()

The column which this rule is evaluated against.

string column = 3;

Returns
TypeDescription
String

The column.

getColumnBytes()

public ByteString getColumnBytes()

The column which this rule is evaluated against.

string column = 3;

Returns
TypeDescription
ByteString

The bytes for column.

getDataSource()

public String getDataSource()

The data source of the data scan (e.g. BigQuery table name).

string data_source = 2;

Returns
TypeDescription
String

The dataSource.

getDataSourceBytes()

public ByteString getDataSourceBytes()

The data source of the data scan (e.g. BigQuery table name).

string data_source = 2;

Returns
TypeDescription
ByteString

The bytes for dataSource.

getDefaultInstanceForType()

public DataQualityScanRuleResult getDefaultInstanceForType()
Returns
TypeDescription
DataQualityScanRuleResult

getEvaluatedRowCount()

public long getEvaluatedRowCount()

The number of rows evaluated against the data quality rule. This field is only valid for rules of PER_ROW evaluation type.

int64 evaluated_row_count = 10;

Returns
TypeDescription
long

The evaluatedRowCount.

getEvalutionType()

public DataQualityScanRuleResult.EvaluationType getEvalutionType()

The evaluation type of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.EvaluationType evalution_type = 6;

Returns
TypeDescription
DataQualityScanRuleResult.EvaluationType

The evalutionType.

getEvalutionTypeValue()

public int getEvalutionTypeValue()

The evaluation type of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.EvaluationType evalution_type = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for evalutionType.

getJobId()

public String getJobId()

Identifier of the specific data scan job this log entry is for.

string job_id = 1;

Returns
TypeDescription
String

The jobId.

getJobIdBytes()

public ByteString getJobIdBytes()

Identifier of the specific data scan job this log entry is for.

string job_id = 1;

Returns
TypeDescription
ByteString

The bytes for jobId.

getNullRowCount()

public long getNullRowCount()

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

int64 null_row_count = 12;

Returns
TypeDescription
long

The nullRowCount.

getParserForType()

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

getPassedRowCount()

public long getPassedRowCount()

The number of rows which passed a rule evaluation. This field is only valid for rules of PER_ROW evaluation type.

int64 passed_row_count = 11;

Returns
TypeDescription
long

The passedRowCount.

getResult()

public DataQualityScanRuleResult.Result getResult()

The result of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.Result result = 9;

Returns
TypeDescription
DataQualityScanRuleResult.Result

The result.

getResultValue()

public int getResultValue()

The result of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.Result result = 9;

Returns
TypeDescription
int

The enum numeric value on the wire for result.

getRuleDimension()

public String getRuleDimension()

The dimension of the data quality rule.

string rule_dimension = 7;

Returns
TypeDescription
String

The ruleDimension.

getRuleDimensionBytes()

public ByteString getRuleDimensionBytes()

The dimension of the data quality rule.

string rule_dimension = 7;

Returns
TypeDescription
ByteString

The bytes for ruleDimension.

getRuleName()

public String getRuleName()

The name of the data quality rule.

string rule_name = 4;

Returns
TypeDescription
String

The ruleName.

getRuleNameBytes()

public ByteString getRuleNameBytes()

The name of the data quality rule.

string rule_name = 4;

Returns
TypeDescription
ByteString

The bytes for ruleName.

getRuleType()

public DataQualityScanRuleResult.RuleType getRuleType()

The type of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.RuleType rule_type = 5;

Returns
TypeDescription
DataQualityScanRuleResult.RuleType

The ruleType.

getRuleTypeValue()

public int getRuleTypeValue()

The type of the data quality rule.

.google.cloud.dataplex.v1.DataQualityScanRuleResult.RuleType rule_type = 5;

Returns
TypeDescription
int

The enum numeric value on the wire for ruleType.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getThresholdPercent()

public double getThresholdPercent()

The passing threshold ([0.0, 100.0]) of the data quality rule.

double threshold_percent = 8;

Returns
TypeDescription
double

The thresholdPercent.

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 DataQualityScanRuleResult.Builder newBuilderForType()
Returns
TypeDescription
DataQualityScanRuleResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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