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 ifsamplingPercentis 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
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'.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-08 UTC."],[[["\u003cp\u003eDataProfileScan settings include options for sampling percentage, row filtering, and post-scan actions.\u003c/p\u003e\n"],["\u003cp\u003ePost-scan actions can include exporting results to a specified BigQuery table.\u003c/p\u003e\n"],["\u003cp\u003eThe sampling percentage for DataScan can be set between 0.0 and 100.0, with sampling disabled if it is unspecified, 0, or 100.\u003c/p\u003e\n"],["\u003cp\u003eYou can filter rows using a SQL \u003ccode\u003eWHERE\u003c/code\u003e clause and select which specific fields to include or exclude in the data profile, with exclusions overriding inclusions.\u003c/p\u003e\n"],["\u003cp\u003eWhen specifying fields to include or exclude, only top-level field names are supported for nested fields.\u003c/p\u003e\n"]]],[],null,["- [JSON representation](#SCHEMA_REPRESENTATION)\n- [PostScanActions](#PostScanActions)\n - [JSON representation](#PostScanActions.SCHEMA_REPRESENTATION)\n- [BigQueryExport](#BigQueryExport)\n - [JSON representation](#BigQueryExport.SCHEMA_REPRESENTATION)\n- [SelectedFields](#SelectedFields)\n - [JSON representation](#SelectedFields.SCHEMA_REPRESENTATION)\n\nDataProfileScan related setting.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"samplingPercent\": number, \"rowFilter\": string, \"postScanActions\": { object (/dataplex/docs/reference/rest/v1/DataProfileSpec#PostScanActions) }, \"includeFields\": { object (/dataplex/docs/reference/rest/v1/DataProfileSpec#SelectedFields) }, \"excludeFields\": { object (/dataplex/docs/reference/rest/v1/DataProfileSpec#SelectedFields) } } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `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 \\\u003e= 0 AND col2 \\\u003c 10 |\n| `postScanActions` | `object (`[PostScanActions](/dataplex/docs/reference/rest/v1/DataProfileSpec#PostScanActions)`)` Optional. Actions to take upon job completion.. |\n| `includeFields` | `object (`[SelectedFields](/dataplex/docs/reference/rest/v1/DataProfileSpec#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`. |\n| `excludeFields` | `object (`[SelectedFields](/dataplex/docs/reference/rest/v1/DataProfileSpec#SelectedFields)`)` Optional. The fields to exclude from data profile. If specified, the fields will be excluded from data profile, regardless of `includeFields` value. |\n\nPostScanActions The configuration of post scan actions of DataProfileScan job.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------|\n| ``` { \"bigqueryExport\": { object (/dataplex/docs/reference/rest/v1/DataProfileSpec#BigQueryExport) } } ``` |\n\n| Fields ||\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `bigqueryExport` | `object (`[BigQueryExport](/dataplex/docs/reference/rest/v1/DataProfileSpec#BigQueryExport)`)` Optional. If set, results will be exported to the provided BigQuery table. |\n\nBigQueryExport The configuration of BigQuery export post scan action.\n\n| JSON representation |\n|------------------------------------|\n| ``` { \"resultsTable\": string } ``` |\n\n| Fields ||\n|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `resultsTable` | `string` Optional. The BigQuery table to export DataProfileScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID |\n\nSelectedFields The specification for fields to include or exclude in data profile scan.\n\n| JSON representation |\n|--------------------------------------|\n| ``` { \"fieldNames\": [ string ] } ``` |\n\n| Fields ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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'. |"]]
