DataProfileSpec

DataProfileScan related setting.

JSON representation 
{
  "samplingPercent": number,
  "rowFilter": string,
  "postScanActions": {
    object (PostScanActions)
  },
  "includeFields": {
    object (SelectedFields)
  },
  "excludeFields": {
    object (SelectedFields)
  }
}
Fields
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..
includeFields

object (SelectedFields)

Optional. The fields to include in data profile.

If not specified, all fields at the time of profile scan job execution are included, except for ones listed in excludeFields.
excludeFields

object (SelectedFields)

Optional. The fields to exclude from data profile.

If specified, the fields will be excluded from data profile, regardless of includeFields value.

PostScanActions

The configuration of post scan actions of DataProfileScan job.

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

object (BigQueryExport)

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

BigQueryExport

The configuration of BigQuery export post scan action.

JSON representation 
{
  "resultsTable": string
}
Fields
resultsTable

string

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

SelectedFields

The specification for fields to include or exclude in data profile scan.

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

string

Optional. Expected input is a list of fully qualified names of fields as in the schema.

Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'.