Google Cloud Dataplex V1 Client - Class DataQualityScanRuleResult (0.11.1)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class DataQualityScanRuleResult.

Information about the result of a data quality rule for data quality scan.

The monitored resource is 'DataScan'.

Generated from protobuf message google.cloud.dataplex.v1.DataQualityScanRuleResult

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ job_id string

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

↳ data_source string

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

↳ column string

The column which this rule is evaluated against.

↳ rule_name string

The name of the data quality rule.

↳ rule_type int

The type of the data quality rule.

↳ evalution_type int

The evaluation type of the data quality rule.

↳ rule_dimension string

The dimension of the data quality rule.

↳ threshold_percent float

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

↳ result int

The result of the data quality rule.

↳ evaluated_row_count int|string

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

↳ passed_row_count int|string

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

↳ null_row_count int|string

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

getJobId

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

Returns
TypeDescription
string

setJobId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDataSource

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

Returns
TypeDescription
string

setDataSource

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getColumn

The column which this rule is evaluated against.

Returns
TypeDescription
string

setColumn

The column which this rule is evaluated against.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRuleName

The name of the data quality rule.

Returns
TypeDescription
string

setRuleName

The name of the data quality rule.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRuleType

The type of the data quality rule.

Returns
TypeDescription
int

setRuleType

The type of the data quality rule.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getEvalutionType

The evaluation type of the data quality rule.

Returns
TypeDescription
int

setEvalutionType

The evaluation type of the data quality rule.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getRuleDimension

The dimension of the data quality rule.

Returns
TypeDescription
string

setRuleDimension

The dimension of the data quality rule.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getThresholdPercent

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

Returns
TypeDescription
float

setThresholdPercent

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

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getResult

The result of the data quality rule.

Returns
TypeDescription
int

setResult

The result of the data quality rule.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getEvaluatedRowCount

The number of rows evaluated against the data quality rule.

This field is only valid for rules of PER_ROW evaluation type.

Returns
TypeDescription
int|string

setEvaluatedRowCount

The number of rows evaluated against the data quality rule.

This field is only valid for rules of PER_ROW evaluation type.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getPassedRowCount

The number of rows which passed a rule evaluation.

This field is only valid for rules of PER_ROW evaluation type.

Returns
TypeDescription
int|string

setPassedRowCount

The number of rows which passed a rule evaluation.

This field is only valid for rules of PER_ROW evaluation type.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getNullRowCount

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

Returns
TypeDescription
int|string

setNullRowCount

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this