Data Loss Prevention V2 Client - Class BigQueryOptions (1.12.0)

Reference documentation and code samples for the Data Loss Prevention V2 Client class BigQueryOptions.

Options defining BigQuery table and row identifiers.

Generated from protobuf message google.privacy.dlp.v2.BigQueryOptions

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ table_reference Google\Cloud\Dlp\V2\BigQueryTable

Complete BigQuery table reference.

↳ identifying_fields array<Google\Cloud\Dlp\V2\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|string

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.

↳ sample_method int
↳ excluded_fields array<Google\Cloud\Dlp\V2\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 array<Google\Cloud\Dlp\V2\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.

getTableReference

Complete BigQuery table reference.

Returns
TypeDescription
Google\Cloud\Dlp\V2\BigQueryTable|null

hasTableReference

clearTableReference

setTableReference

Complete BigQuery table reference.

Parameter
NameDescription
var Google\Cloud\Dlp\V2\BigQueryTable
Returns
TypeDescription
$this

getIdentifyingFields

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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setIdentifyingFields

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.

Parameter
NameDescription
var array<Google\Cloud\Dlp\V2\FieldId>
Returns
TypeDescription
$this

getRowsLimit

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.

Returns
TypeDescription
int|string

setRowsLimit

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.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getRowsLimitPercent

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.

Returns
TypeDescription
int

setRowsLimitPercent

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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSampleMethod

Generated from protobuf field .google.privacy.dlp.v2.BigQueryOptions.SampleMethod sample_method = 4;

Returns
TypeDescription
int

setSampleMethod

Generated from protobuf field .google.privacy.dlp.v2.BigQueryOptions.SampleMethod sample_method = 4;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getExcludedFields

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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setExcludedFields

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.

Parameter
NameDescription
var array<Google\Cloud\Dlp\V2\FieldId>
Returns
TypeDescription
$this

getIncludedFields

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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setIncludedFields

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.

Parameter
NameDescription
var array<Google\Cloud\Dlp\V2\FieldId>
Returns
TypeDescription
$this