Google Cloud Dataplex V1 Client - Class DataQualityResult (1.9.1)
Stay organized with collections
Save and categorize content based on your preferences.
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
Output only. 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<DataQualityDimensionResult>
Output only. A list of results at the dimension level. A dimension will have a corresponding |
↳ columns |
array<DataQualityColumnResult>
Output only. A list of results at the column level. A column will have a corresponding |
↳ rules |
array<DataQualityRuleResult>
Output only. A list of all the rules in a job, and their results. |
↳ row_count |
int|string
Output only. The count of rows processed. |
↳ scanned_data |
ScannedData
Output only. The data scanned for this result. |
↳ post_scan_actions_result |
DataQualityResult\PostScanActionsResult
Output only. The result of post scan actions. |
↳ catalog_publishing_status |
DataScanCatalogPublishingStatus
Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata. |
getPassed
Output only. Overall data quality result -- true if all rules passed.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setPassed
Output only. 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
Output only. 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
Output only. 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<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<DataQualityColumnResult>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRules
Output only. A list of all the rules in a job, and their results.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setRules
Output only. A list of all the rules in a job, and their results.
| Parameter | |
|---|---|
| Name | Description |
var |
array<DataQualityRuleResult>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRowCount
Output only. The count of rows processed.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setRowCount
Output only. The count of rows processed.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScannedData
Output only. The data scanned for this result.
| Returns | |
|---|---|
| Type | Description |
ScannedData|null |
|
hasScannedData
clearScannedData
setScannedData
Output only. The data scanned for this result.
| Parameter | |
|---|---|
| Name | Description |
var |
ScannedData
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPostScanActionsResult
Output only. The result of post scan actions.
| Returns | |
|---|---|
| Type | Description |
DataQualityResult\PostScanActionsResult|null |
|
hasPostScanActionsResult
clearPostScanActionsResult
setPostScanActionsResult
Output only. The result of post scan actions.
| Parameter | |
|---|---|
| Name | Description |
var |
DataQualityResult\PostScanActionsResult
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCatalogPublishingStatus
Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata.
| Returns | |
|---|---|
| Type | Description |
DataScanCatalogPublishingStatus|null |
|
hasCatalogPublishingStatus
clearCatalogPublishingStatus
setCatalogPublishingStatus
Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata.
| Parameter | |
|---|---|
| Name | Description |
var |
DataScanCatalogPublishingStatus
|
| Returns | |
|---|---|
| Type | Description |
$this |
|