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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
string | |
setJobId
Identifier of the specific data scan job this log entry is for.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDataSource
The data source of the data scan (e.g. BigQuery table name).
| Returns | |
|---|---|
| Type | Description |
string | |
setDataSource
The data source of the data scan (e.g. BigQuery table name).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getColumn
The column which this rule is evaluated against.
| Returns | |
|---|---|
| Type | Description |
string | |
setColumn
The column which this rule is evaluated against.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRuleName
The name of the data quality rule.
| Returns | |
|---|---|
| Type | Description |
string | |
setRuleName
The name of the data quality rule.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRuleType
The type of the data quality rule.
| Returns | |
|---|---|
| Type | Description |
int | |
setRuleType
The type of the data quality rule.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEvalutionType
The evaluation type of the data quality rule.
| Returns | |
|---|---|
| Type | Description |
int | |
setEvalutionType
The evaluation type of the data quality rule.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRuleDimension
The dimension of the data quality rule.
| Returns | |
|---|---|
| Type | Description |
string | |
setRuleDimension
The dimension of the data quality rule.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getThresholdPercent
The passing threshold ([0.0, 100.0]) of the data quality rule.
| Returns | |
|---|---|
| Type | Description |
float | |
setThresholdPercent
The passing threshold ([0.0, 100.0]) of the data quality rule.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResult
The result of the data quality rule.
| Returns | |
|---|---|
| Type | Description |
int | |
setResult
The result of the data quality rule.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPassedRowCount
The number of rows which passed a rule evaluation.
This field is only valid for rules of PER_ROW evaluation type.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNullRowCount
The number of rows with null values in the specified column.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setNullRowCount
The number of rows with null values in the specified column.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |