Class BigQueryOptions (3.15.3)

BigQueryOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Options defining BigQuery table and row identifiers.

Attributes

NameDescription
table_reference google.cloud.dlp_v2.types.BigQueryTable
Complete BigQuery table reference.
identifying_fields MutableSequence[google.cloud.dlp_v2.types.FieldId]
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.
rows_limit int
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.
rows_limit_percent int
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.
excluded_fields MutableSequence[google.cloud.dlp_v2.types.FieldId]
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.
included_fields MutableSequence[google.cloud.dlp_v2.types.FieldId]
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.

Classes

SampleMethod

SampleMethod(value)

How to sample rows if not all rows are scanned. Meaningful only when used in conjunction with either rows_limit or rows_limit_percent. If not specified, rows are scanned in the order BigQuery reads them.

Values: SAMPLE_METHOD_UNSPECIFIED (0): No description available. TOP (1): Scan groups of rows in the order BigQuery provides (default). Multiple groups of rows may be scanned in parallel, so results may not appear in the same order the rows are read. RANDOM_START (2): Randomly pick groups of rows to scan.