Reference documentation and code samples for the Google Cloud Dataplex V1 Client class DataQualityResult.
The output of a DataQualityScan.
Generated from protobuf message google.cloud.dataplex.v1.DataQualityResult
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ passed |
bool
Overall data quality result -- |
↳ score |
float
Output only. The overall data quality score. The score ranges between [0, 100] (up to two decimal points). |
↳ dimensions |
array<Google\Cloud\Dataplex\V1\DataQualityDimensionResult>
A list of results at the dimension level. A dimension will have a corresponding |
↳ columns |
array<Google\Cloud\Dataplex\V1\DataQualityColumnResult>
Output only. A list of results at the column level. A column will have a corresponding |
↳ rules |
array<Google\Cloud\Dataplex\V1\DataQualityRuleResult>
A list of all the rules in a job, and their results. |
↳ row_count |
int|string
The count of rows processed. |
↳ scanned_data |
Google\Cloud\Dataplex\V1\ScannedData
The data scanned for this result. |
↳ post_scan_actions_result |
Google\Cloud\Dataplex\V1\DataQualityResult\PostScanActionsResult
Output only. The result of post scan actions. |
getPassed
Overall data quality result -- true if all rules passed.
| Returns | |
|---|---|
| Type | Description |
bool | |
setPassed
Overall data quality result -- true if all rules passed.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getScore
Output only. The overall data quality score.
The score ranges between [0, 100] (up to two decimal points).
| Returns | |
|---|---|
| Type | Description |
float | |
hasScore
clearScore
setScore
Output only. The overall data quality score.
The score ranges between [0, 100] (up to two decimal points).
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDimensions
A list of results at the dimension level.
A dimension will have a corresponding DataQualityDimensionResult if and
only if there is at least one rule with the 'dimension' field set to it.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setDimensions
A list of results at the dimension level.
A dimension will have a corresponding DataQualityDimensionResult if and
only if there is at least one rule with the 'dimension' field set to it.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dataplex\V1\DataQualityDimensionResult>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getColumns
Output only. A list of results at the column level.
A column will have a corresponding DataQualityColumnResult if and only if
there is at least one rule with the 'column' field set to it.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setColumns
Output only. A list of results at the column level.
A column will have a corresponding DataQualityColumnResult if and only if
there is at least one rule with the 'column' field set to it.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dataplex\V1\DataQualityColumnResult>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRules
A list of all the rules in a job, and their results.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setRules
A list of all the rules in a job, and their results.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dataplex\V1\DataQualityRuleResult>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRowCount
The count of rows processed.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setRowCount
The count of rows processed.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getScannedData
The data scanned for this result.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\ScannedData|null | |
hasScannedData
clearScannedData
setScannedData
The data scanned for this result.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\ScannedData
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPostScanActionsResult
Output only. The result of post scan actions.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\DataQualityResult\PostScanActionsResult|null | |
hasPostScanActionsResult
clearPostScanActionsResult
setPostScanActionsResult
Output only. The result of post scan actions.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\DataQualityResult\PostScanActionsResult
|
| Returns | |
|---|---|
| Type | Description |
$this | |