(::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
GoogleSQL
syntax.
Example: col1 >= 0 AND col2 < 10
#row_filter=
defrow_filter=(value)->::String
Parameter
value (::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
GoogleSQL
syntax.
Example: col1 >= 0 AND col2 < 10
Returns
(::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
GoogleSQL
syntax.
Example: col1 >= 0 AND col2 < 10
#sampling_percent
defsampling_percent()->::Float
Returns
(::Float) —
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 sampling_percent is not specified, 0 or
100.
#sampling_percent=
defsampling_percent=(value)->::Float
Parameter
value (::Float) —
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 sampling_percent is not specified, 0 or
100.
Returns
(::Float) —
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 sampling_percent is not specified, 0 or
100.
[[["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-04 UTC."],[],[],null,["# Dataplex V1 API - Class Google::Cloud::Dataplex::V1::DataProfileSpec (v2.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.5.0 (latest)](/ruby/docs/reference/google-cloud-dataplex-v1/latest/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [2.4.1](/ruby/docs/reference/google-cloud-dataplex-v1/2.4.1/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [2.3.1](/ruby/docs/reference/google-cloud-dataplex-v1/2.3.1/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [2.2.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.2.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [2.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.1.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [2.0.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.0.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [1.4.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.4.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [1.3.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.3.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [1.2.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.2.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [1.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.1.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [1.0.1](/ruby/docs/reference/google-cloud-dataplex-v1/1.0.1/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.23.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.23.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.22.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.22.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.21.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.21.1/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.20.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.20.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.19.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.19.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.18.2](/ruby/docs/reference/google-cloud-dataplex-v1/0.18.2/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.17.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.17.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.16.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.16.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.15.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.15.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.14.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.14.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.13.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.13.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.12.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.12.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.11.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.11.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.10.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.10.1/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.9.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.9.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.8.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.8.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.7.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.7.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.6.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.6.1/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.5.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.5.1/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.4.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.4.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.3.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.3.0/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.2.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.2.1/Google-Cloud-Dataplex-V1-DataProfileSpec)\n- [0.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.1.0/Google-Cloud-Dataplex-V1-DataProfileSpec) \nReference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::DataProfileSpec.\n\nDataProfileScan related setting. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #exclude_fields\n\n def exclude_fields() -\u003e ::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields](./Google-Cloud-Dataplex-V1-DataProfileSpec-SelectedFields)) --- Optional. The fields to exclude from data profile.\n\n\n If specified, the fields will be excluded from data profile, regardless of\n `include_fields` value.\n\n### #exclude_fields=\n\n def exclude_fields=(value) -\u003e ::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields](./Google-Cloud-Dataplex-V1-DataProfileSpec-SelectedFields)) --- Optional. The fields to exclude from data profile.\n\n\n If specified, the fields will be excluded from data profile, regardless of\n`include_fields` value. \n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields](./Google-Cloud-Dataplex-V1-DataProfileSpec-SelectedFields)) --- Optional. The fields to exclude from data profile.\n\n\n If specified, the fields will be excluded from data profile, regardless of\n `include_fields` value.\n\n### #include_fields\n\n def include_fields() -\u003e ::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields](./Google-Cloud-Dataplex-V1-DataProfileSpec-SelectedFields)) --- Optional. The fields to include in data profile.\n\n\n If not specified, all fields at the time of profile scan job execution are\n included, except for ones listed in `exclude_fields`.\n\n### #include_fields=\n\n def include_fields=(value) -\u003e ::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields](./Google-Cloud-Dataplex-V1-DataProfileSpec-SelectedFields)) --- Optional. The fields to include in data profile.\n\n\n If not specified, all fields at the time of profile scan job execution are\nincluded, except for ones listed in `exclude_fields`. \n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::DataProfileSpec::SelectedFields](./Google-Cloud-Dataplex-V1-DataProfileSpec-SelectedFields)) --- Optional. The fields to include in data profile.\n\n\n If not specified, all fields at the time of profile scan job execution are\n included, except for ones listed in `exclude_fields`.\n\n### #post_scan_actions\n\n def post_scan_actions() -\u003e ::Google::Cloud::Dataplex::V1::DataProfileSpec::PostScanActions\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::DataProfileSpec::PostScanActions](./Google-Cloud-Dataplex-V1-DataProfileSpec-PostScanActions)) --- Optional. Actions to take upon job completion..\n\n### #post_scan_actions=\n\n def post_scan_actions=(value) -\u003e ::Google::Cloud::Dataplex::V1::DataProfileSpec::PostScanActions\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dataplex::V1::DataProfileSpec::PostScanActions](./Google-Cloud-Dataplex-V1-DataProfileSpec-PostScanActions)) --- Optional. Actions to take upon job completion.. \n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::DataProfileSpec::PostScanActions](./Google-Cloud-Dataplex-V1-DataProfileSpec-PostScanActions)) --- Optional. Actions to take upon job completion..\n\n### #row_filter\n\n def row_filter() -\u003e ::String\n\n**Returns**\n\n- (::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\n GoogleSQL\n syntax](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).\n\n\n Example: col1 \\\u003e= 0 AND col2 \\\u003c 10\n\n### #row_filter=\n\n def row_filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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\n GoogleSQL\n syntax](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).\n\n\nExample: col1 \\\u003e= 0 AND col2 \\\u003c 10 \n**Returns**\n\n- (::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\n GoogleSQL\n syntax](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).\n\n\n Example: col1 \\\u003e= 0 AND col2 \\\u003c 10\n\n### #sampling_percent\n\n def sampling_percent() -\u003e ::Float\n\n**Returns**\n\n- (::Float) --- Optional. The percentage of the records to be selected from the dataset for\n DataScan.\n\n - Value can range between 0.0 and 100.0 with up to 3 significant decimal digits.\n - Sampling is not applied if `sampling_percent` is not specified, 0 or 100.\n\n### #sampling_percent=\n\n def sampling_percent=(value) -\u003e ::Float\n\n**Parameter**\n\n- **value** (::Float) ---\n\n Optional. The percentage of the records to be selected from the dataset for\n DataScan.\n - Value can range between 0.0 and 100.0 with up to 3 significant decimal digits.\n- Sampling is not applied if `sampling_percent` is not specified, 0 or 100. \n**Returns**\n\n- (::Float) --- Optional. The percentage of the records to be selected from the dataset for\n DataScan.\n\n - Value can range between 0.0 and 100.0 with up to 3 significant decimal digits.\n - Sampling is not applied if `sampling_percent` is not specified, 0 or 100."]]
