public sealed class BigQueryOptions : IMessage<BigQueryOptions>, IEquatable<BigQueryOptions>, IDeepCloneable<BigQueryOptions>, IBufferMessage, IMessage
Reference documentation and code samples for the Google Cloud Data Loss Prevention v2 API class BigQueryOptions.
Options defining BigQuery table and row identifiers.
public RepeatedField<FieldId> ExcludedFields { get; }
References to fields excluded from scanning. This allows you to skip
inspection of entire columns which you know have no findings.
When inspecting a table, we recommend that you inspect all columns.
Otherwise, findings might be affected because hints from excluded columns
will not be used.
public RepeatedField<FieldId> IdentifyingFields { get; }
Table fields that may uniquely identify a row within the table. When
actions.saveFindings.outputConfig.table is specified, the values of
columns specified here are available in the output table under
location.content_locations.record_location.record_key.id_values. Nested
fields such as person.birthdate.year are allowed.
public RepeatedField<FieldId> IncludedFields { get; }
Limit scanning only to these fields.
When inspecting a table, we recommend that you inspect all columns.
Otherwise, findings might be affected because hints from excluded columns
will not be used.
Max number of rows to scan. If the table has more rows than this value, the
rest of the rows are omitted. If not set, or if set to 0, all rows will be
scanned. Only one of rows_limit and rows_limit_percent can be specified.
Cannot be used in conjunction with TimespanConfig.
Max percentage of rows to scan. The rest are omitted. The number of rows
scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and
100 means no limit. Defaults to 0. Only one of rows_limit and
rows_limit_percent can be specified. Cannot be used in conjunction with
TimespanConfig.
Caution: A known
issue
is causing the rowsLimitPercent field to behave unexpectedly. We
recommend using rowsLimit instead.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis document provides reference documentation for the \u003ccode\u003eBigQueryOptions\u003c/code\u003e class within the Google Cloud Data Loss Prevention (DLP) v2 API for .NET.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eBigQueryOptions\u003c/code\u003e class defines configurations for interacting with BigQuery tables, including specifying which fields to include or exclude during data scanning.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation covers the class's constructors, properties like \u003ccode\u003eExcludedFields\u003c/code\u003e, \u003ccode\u003eIdentifyingFields\u003c/code\u003e, \u003ccode\u003eIncludedFields\u003c/code\u003e, \u003ccode\u003eRowsLimit\u003c/code\u003e, \u003ccode\u003eRowsLimitPercent\u003c/code\u003e, \u003ccode\u003eSampleMethod\u003c/code\u003e, and \u003ccode\u003eTableReference\u003c/code\u003e, detailing their purpose and usage.\u003c/p\u003e\n"],["\u003cp\u003eThere is a list of documented versions of the package provided, with the most recent version being 4.16.0, and the list goes as far back as 2.15.0.\u003c/p\u003e\n"],["\u003cp\u003eThere is a caution mentioned regarding the \u003ccode\u003erowsLimitPercent\u003c/code\u003e field, recommending the use of \u003ccode\u003erowsLimit\u003c/code\u003e instead due to a known issue.\u003c/p\u003e\n"]]],[],null,["# Google Cloud Data Loss Prevention v2 API - Class BigQueryOptions (4.19.0)\n\nVersion latestkeyboard_arrow_down\n\n- [4.19.0 (latest)](/dotnet/docs/reference/Google.Cloud.Dlp.V2/latest/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.18.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.18.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.17.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.17.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.16.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.16.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.15.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.15.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.14.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.14.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.13.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.13.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.12.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.12.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.11.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.11.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.10.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.10.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.9.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.9.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.8.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.8.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.7.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.7.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.6.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.6.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.5.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.5.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.4.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.4.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.3.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.3.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.2.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.2.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.1.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.1.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [4.0.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/4.0.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/3.5.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/3.4.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/3.3.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/3.2.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [2.16.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/2.16.0/Google.Cloud.Dlp.V2.BigQueryOptions)\n- [2.15.0](/dotnet/docs/reference/Google.Cloud.Dlp.V2/2.15.0/Google.Cloud.Dlp.V2.BigQueryOptions) \n\n public sealed class BigQueryOptions : IMessage\u003cBigQueryOptions\u003e, IEquatable\u003cBigQueryOptions\u003e, IDeepCloneable\u003cBigQueryOptions\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Google Cloud Data Loss Prevention v2 API class BigQueryOptions.\n\nOptions defining BigQuery table and row identifiers. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e BigQueryOptions \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[BigQueryOptions](/dotnet/docs/reference/Google.Cloud.Dlp.V2/latest/Google.Cloud.Dlp.V2.BigQueryOptions), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[BigQueryOptions](/dotnet/docs/reference/Google.Cloud.Dlp.V2/latest/Google.Cloud.Dlp.V2.BigQueryOptions), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[BigQueryOptions](/dotnet/docs/reference/Google.Cloud.Dlp.V2/latest/Google.Cloud.Dlp.V2.BigQueryOptions), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Dlp.V2](/dotnet/docs/reference/Google.Cloud.Dlp.V2/latest/Google.Cloud.Dlp.V2)\n\nAssembly\n--------\n\nGoogle.Cloud.Dlp.V2.dll\n\nConstructors\n------------\n\n### BigQueryOptions()\n\n public BigQueryOptions()\n\n### BigQueryOptions(BigQueryOptions)\n\n public BigQueryOptions(BigQueryOptions other)\n\nProperties\n----------\n\n### ExcludedFields\n\n public RepeatedField\u003cFieldId\u003e ExcludedFields { get; }\n\nReferences to fields excluded from scanning. This allows you to skip\ninspection of entire columns which you know have no findings.\nWhen inspecting a table, we recommend that you inspect all columns.\nOtherwise, findings might be affected because hints from excluded columns\nwill not be used.\n\n### IdentifyingFields\n\n public RepeatedField\u003cFieldId\u003e IdentifyingFields { get; }\n\nTable fields that may uniquely identify a row within the table. When\n`actions.saveFindings.outputConfig.table` is specified, the values of\ncolumns specified here are available in the output table under\n`location.content_locations.record_location.record_key.id_values`. Nested\nfields such as `person.birthdate.year` are allowed.\n\n### IncludedFields\n\n public RepeatedField\u003cFieldId\u003e IncludedFields { get; }\n\nLimit scanning only to these fields.\nWhen inspecting a table, we recommend that you inspect all columns.\nOtherwise, findings might be affected because hints from excluded columns\nwill not be used.\n\n### RowsLimit\n\n public long RowsLimit { get; set; }\n\nMax number of rows to scan. If the table has more rows than this value, the\nrest of the rows are omitted. If not set, or if set to 0, all rows will be\nscanned. Only one of rows_limit and rows_limit_percent can be specified.\nCannot be used in conjunction with TimespanConfig.\n\n### RowsLimitPercent\n\n public int RowsLimitPercent { get; set; }\n\nMax percentage of rows to scan. The rest are omitted. The number of rows\nscanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and\n100 means no limit. Defaults to 0. Only one of rows_limit and\nrows_limit_percent can be specified. Cannot be used in conjunction with\nTimespanConfig.\n\nCaution: A [known\nissue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling)\nis causing the `rowsLimitPercent` field to behave unexpectedly. We\nrecommend using `rowsLimit` instead.\n\n### SampleMethod\n\n public BigQueryOptions.Types.SampleMethod SampleMethod { get; set; }\n\nHow to sample the data.\n\n### TableReference\n\n public BigQueryTable TableReference { get; set; }\n\nComplete BigQuery table reference."]]
