- JSON representation
- DataQualityDimensionResult
- DataQualityDimension
- DataQualityColumnResult
- DataQualityRuleResult
- PostScanActionsResult
- BigQueryExportResult
- State
- AnomalyDetectionGeneratedAssets
The output of a DataQualityScan.
| JSON representation |
|---|
{ "passed" : boolean , "dimensions" : [ { object ( |
| Fields | |
|---|---|
passed
|
Output only. Overall data quality result -- |
dimensions[]
|
Output only. A list of results at the dimension level. A dimension will have a corresponding |
columns[]
|
Output only. A list of results at the column level. A column will have a corresponding |
rules[]
|
Output only. A list of all the rules in a job, and their results. |
rowCount
|
Output only. The count of rows processed. |
scannedData
|
Output only. The data scanned for this result. |
postScanActionsResult
|
Output only. The result of post scan actions. |
catalogPublishingStatus
|
Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata. |
anomalyDetectionGeneratedAssets
|
Output only. The generated assets for anomaly detection. |
score
|
Output only. The overall data quality score. The score ranges between [0, 100] (up to two decimal points). |
DataQualityDimensionResult
DataQualityDimensionResult provides a more detailed, per-dimension view of the results.
| JSON representation |
|---|
{
"dimension"
:
{
object (
|
| Fields | |
|---|---|
dimension
|
Output only. The dimension config specified in the DataQualitySpec, as is. |
passed
|
Output only. Whether the dimension passed or failed. |
score
|
Output only. The dimension-level data quality score for this data scan job if and only if the 'dimension' field is set. The score ranges between [0, 100] (up to two decimal points). |
DataQualityDimension
A dimension captures data quality intent about a defined subset of the rules specified.
| JSON representation |
|---|
{ "name" : string } |
| Fields | |
|---|---|
name
|
Output only. The dimension name a rule belongs to. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. |
DataQualityColumnResult
DataQualityColumnResult provides a more detailed, per-column view of the results.
| JSON representation |
|---|
{
"column"
:
string
,
"passed"
:
boolean
,
"dimensions"
:
[
{
object (
|
| Fields | |
|---|---|
column
|
Output only. The column specified in the DataQualityRule. |
passed
|
Output only. Whether the column passed or failed. |
dimensions[]
|
Output only. The dimension-level results for this column. |
score
|
Output only. The column-level data quality score for this data scan job if and only if the 'column' field is set. The score ranges between between [0, 100] (up to two decimal points). |
DataQualityRuleResult
DataQualityRuleResult provides a more detailed, per-rule view of the results.
| JSON representation |
|---|
{
"rule"
:
{
object (
|
rule
object (
DataQualityRule
)
Output only. The rule specified in the DataQualitySpec, as is.
passed
boolean
Output only. Whether the rule passed or failed.
evaluatedCount
string ( int64
format)
Output only. The number of rows a rule was evaluated against.
This field is only valid for row-level type rules.
Evaluated count can be configured to either
- include all rows (default) - with
nullrows automatically failing rule evaluation, or - exclude
nullrows from theevaluatedCount, by settingignore_nulls = true.
This field is not set for rule SqlAssertion.
passedCount
string ( int64
format)
Output only. The number of rows which passed a rule evaluation.
This field is only valid for row-level type rules.
This field is not set for rule SqlAssertion.
nullCount
string ( int64
format)
Output only. The number of rows with null values in the specified column.
passRatio
number
Output only. The ratio of passedCount / evaluatedCount.
This field is only valid for row-level type rules.
failingRowsQuery
string
Output only. The query to find rows that did not pass this rule.
This field is only valid for row-level type rules.
assertionRowCount
string ( int64
format)
Output only. The number of rows returned by the SQL statement in a SQL assertion rule.
This field is only valid for SQL assertion rules.
PostScanActionsResult
The result of post scan actions of DataQualityScan job.
| JSON representation |
|---|
{
"bigqueryExportResult"
:
{
object (
|
| Fields | |
|---|---|
bigqueryExportResult
|
Output only. The result of BigQuery export post scan action. |
BigQueryExportResult
The result of BigQuery export post scan action.
| JSON representation |
|---|
{
"state"
:
enum (
|
| Fields | |
|---|---|
state
|
Output only. Execution state for the BigQuery exporting. |
State
Execution state for the exporting.
| Enums | |
|---|---|
STATE_UNSPECIFIED
|
The exporting state is unspecified. |
SUCCEEDED
|
The exporting completed successfully. |
FAILED
|
The exporting is no longer running due to an error. |
SKIPPED
|
The exporting is skipped due to no valid scan result to export (usually caused by scan failed). |
AnomalyDetectionGeneratedAssets
The assets generated by Anomaly Detection Data Scan.
| JSON representation |
|---|
{ "resultTable" : string , "dataIntermediateTable" : string , "freshnessIntermediateTable" : string , "volumeIntermediateTable" : string } |
| Fields | |
|---|---|
resultTable
|
Output only. The result table for anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID If the result table is set at AnomalyDetectionAssets, the result table here would be the same as the one set in the AnomalyDetectionAssets.result_table. |
dataIntermediateTable
|
Output only. The intermediate table for data anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID |
freshnessIntermediateTable
|
Output only. The intermediate table for freshness anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID |
volumeIntermediateTable
|
Output only. The intermediate table for volume anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID |

