DataQualityResult

The output of a DataQualityScan.

JSON representation 
{
  "passed": boolean,
  "dimensions": [
    {
      object (DataQualityDimensionResult)
    }
  ],
  "columns": [
    {
      object (DataQualityColumnResult)
    }
  ],
  "rules": [
    {
      object (DataQualityRuleResult)
    }
  ],
  "rowCount": string,
  "scannedData": {
    object (ScannedData)
  },
  "postScanActionsResult": {
    object (PostScanActionsResult)
  },
  "catalogPublishingStatus": {
    object (DataScanCatalogPublishingStatus)
  },
  "score": number
}
Fields
passed

boolean

Output only. Overall data quality result -- true if all rules passed.
dimensions[]

object (DataQualityDimensionResult)

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.
columns[]

object (DataQualityColumnResult)

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.
rules[]

object (DataQualityRuleResult)

Output only. A list of all the rules in a job, and their results.
rowCount

string (int64 format)

Output only. The count of rows processed.
scannedData

object (ScannedData)

Output only. The data scanned for this result.
postScanActionsResult

object (PostScanActionsResult)

Output only. The result of post scan actions.
catalogPublishingStatus

object (DataScanCatalogPublishingStatus)

Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata.
score

number

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 (DataQualityDimension)
  },
  "passed": boolean,
  "score": number
}
Fields
dimension

object (DataQualityDimension)

Output only. The dimension config specified in the DataQualitySpec, as is.
passed

boolean

Output only. Whether the dimension passed or failed.
score

number

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

string

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 (DataQualityDimensionResult)
    }
  ],
  "score": number
}
Fields
column

string

Output only. The column specified in the DataQualityRule.
passed

boolean

Output only. Whether the column passed or failed.
dimensions[]

object (DataQualityDimensionResult)

Output only. The dimension-level results for this column.
score

number

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 (DataQualityRule)
  },
  "passed": boolean,
  "evaluatedCount": string,
  "passedCount": string,
  "nullCount": string,
  "passRatio": number,
  "failingRowsQuery": string,
  "assertionRowCount": string
}
Fields
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 null rows automatically failing rule evaluation, or
  • exclude null rows from the evaluatedCount, by setting ignore_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 (BigQueryExportResult)
  }
}
Fields
bigqueryExportResult

object (BigQueryExportResult)

Output only. The result of BigQuery export post scan action.

BigQueryExportResult

The result of BigQuery export post scan action.

JSON representation 
{
  "state": enum (State),
  "message": string
}
Fields
state

enum (State)

Output only. Execution state for the BigQuery exporting.
message

string

Output only. Additional information about 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).

DataScanCatalogPublishingStatus

The status of publishing the data scan result as Dataplex Universal Catalog metadata.

JSON representation 
{
  "state": enum (State)
}
Fields
state

enum (State)

Output only. Execution state for catalog publishing.

State

Execution state for the publishing.

Enums
STATE_UNSPECIFIED The publishing state is unspecified.
SUCCEEDED Publish to catalog completed successfully.
FAILED Publish to catalog failed.