Reference documentation and code samples for the Google Cloud Dataplex V1 Client class DataProfileSpec.
DataProfileScan related setting.
Generated from protobuf message google.cloud.dataplex.v1.DataProfileSpec
Namespace
Google \ Cloud \ Dataplex \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ sampling_percent
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.
↳ row_filter
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
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 exclude_fields.
[[["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-09 UTC."],[],[],null,["# Google Cloud Dataplex V1 Client - Class DataProfileSpec (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.DataProfileSpec)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.DataProfileSpec)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.DataProfileSpec)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.DataProfileSpec)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.DataProfileSpec)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.DataProfileSpec)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.DataProfileSpec)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.DataProfileSpec)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.DataProfileSpec)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.DataProfileSpec)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.DataProfileSpec)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.DataProfileSpec)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.DataProfileSpec)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.DataProfileSpec)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.DataProfileSpec)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.DataProfileSpec)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.DataProfileSpec)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.DataProfileSpec)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.DataProfileSpec)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.DataProfileSpec)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.DataProfileSpec)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.DataProfileSpec)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.DataProfileSpec)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.DataProfileSpec) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class DataProfileSpec.\n\nDataProfileScan related setting.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.DataProfileSpec`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getSamplingPercent\n\nOptional. The percentage of the records to be selected from the dataset for\nDataScan.\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### setSamplingPercent\n\nOptional. The percentage of the records to be selected from the dataset for\nDataScan.\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### getRowFilter\n\nOptional. A filter applied to all rows in a single DataScan job.\n\nThe filter needs to be a valid SQL expression for a [WHERE clause in\nGoogleSQL\nsyntax](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).\nExample: col1 \\\u003e= 0 AND col2 \\\u003c 10\n\n### setRowFilter\n\nOptional. A filter applied to all rows in a single DataScan job.\n\nThe filter needs to be a valid SQL expression for a [WHERE clause in\nGoogleSQL\nsyntax](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).\nExample: col1 \\\u003e= 0 AND col2 \\\u003c 10\n\n### getPostScanActions\n\nOptional. Actions to take upon job completion..\n\nGenerated from protobuf field `.google.cloud.dataplex.v1.DataProfileSpec.PostScanActions post_scan_actions = 4 [(.google.api.field_behavior) = OPTIONAL];`\n\n### hasPostScanActions\n\n### clearPostScanActions\n\n### setPostScanActions\n\nOptional. Actions to take upon job completion..\n\nGenerated from protobuf field `.google.cloud.dataplex.v1.DataProfileSpec.PostScanActions post_scan_actions = 4 [(.google.api.field_behavior) = OPTIONAL];`\n\n### getIncludeFields\n\nOptional. The fields to include in data profile.\n\nIf not specified, all fields at the time of profile scan job execution are\nincluded, except for ones listed in `exclude_fields`.\n\n### hasIncludeFields\n\n### clearIncludeFields\n\n### setIncludeFields\n\nOptional. The fields to include in data profile.\n\nIf not specified, all fields at the time of profile scan job execution are\nincluded, except for ones listed in `exclude_fields`.\n\n### getExcludeFields\n\nOptional. The fields to exclude from data profile.\n\nIf specified, the fields will be excluded from data profile, regardless of\n`include_fields` value.\n\n### hasExcludeFields\n\n### clearExcludeFields\n\n### setExcludeFields\n\nOptional. The fields to exclude from data profile.\n\nIf specified, the fields will be excluded from data profile, regardless of\n`include_fields` value."]]
