DataQualitySpec

DataQualityScan related setting.

JSON representation 
{
  "rules": [
    {
      object (DataQualityRule)
    }
  ],
  "samplingPercent": number,
  "rowFilter": string,
  "postScanActions": {
    object (PostScanActions)
  }
}
Fields
rules[]

object (DataQualityRule)

Required. The list of rules to evaluate against a data source. At least one rule is required.
samplingPercent

number

Optional. The percentage of the records to be selected from the dataset for DataScan.

  • Value can range between 0.0 and 100.0 with up to 3 significant decimal digits.
  • Sampling is not applied if samplingPercent is not specified, 0 or 100.
rowFilter

string

Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10
postScanActions

object (PostScanActions)

Optional. Actions to take upon job completion.

PostScanActions

The configuration of post scan actions of DataQualityScan.

JSON representation 
{
  "bigqueryExport": {
    object (BigQueryExport)
  },
  "notificationReport": {
    object (NotificationReport)
  }
}
Fields
bigqueryExport

object (BigQueryExport)

Optional. If set, results will be exported to the provided BigQuery table.
notificationReport

object (NotificationReport)

Optional. If set, results will be sent to the provided notification receipts upon triggers.

BigQueryExport

The configuration of BigQuery export post scan action.

JSON representation 
{
  "resultsTable": string
}
Fields
resultsTable

string

Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID

NotificationReport

The configuration of notification report post scan action.

JSON representation 
{
  "recipients": {
    object (Recipients)
  },
  "scoreThresholdTrigger": {
    object (ScoreThresholdTrigger)
  },
  "jobFailureTrigger": {
    object (JobFailureTrigger)
  },
  "jobEndTrigger": {
    object (JobEndTrigger)
  }
}
Fields
recipients

object (Recipients)

Required. The recipients who will receive the notification report.
scoreThresholdTrigger

object (ScoreThresholdTrigger)

Optional. If set, report will be sent when score threshold is met.
jobFailureTrigger

object (JobFailureTrigger)

Optional. If set, report will be sent when a scan job fails.
jobEndTrigger

object (JobEndTrigger)

Optional. If set, report will be sent when a scan job ends.

Recipients

The individuals or groups who are designated to receive notifications upon triggers.

JSON representation 
{
  "emails": [
    string
  ]
}
Fields
emails[]

string

Optional. The email recipients who will receive the DataQualityScan results report.

ScoreThresholdTrigger

This trigger is triggered when the DQ score in the job result is less than a specified input score.

JSON representation 
{
  "scoreThreshold": number
}
Fields
scoreThreshold

number

Optional. The score range is in [0,100].

JobFailureTrigger

This type has no fields.

This trigger is triggered when the scan job itself fails, regardless of the result.

JobEndTrigger

This type has no fields.

This trigger is triggered whenever a scan job run ends, regardless of the result.