Class BigQueryOptions.Builder (3.46.0) 

public static final class BigQueryOptions.Builder extends GeneratedMessageV3.Builder<BigQueryOptions.Builder> implements BigQueryOptionsOrBuilder

Options defining BigQuery table and row identifiers.

Protobuf type google.privacy.dlp.v2.BigQueryOptions

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BigQueryOptions.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllExcludedFields(Iterable<? extends FieldId> values)

public BigQueryOptions.Builder addAllExcludedFields(Iterable<? extends FieldId> values)

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Parameter
Name Description
values Iterable<? extends com.google.privacy.dlp.v2.FieldId>
Returns
Type Description
BigQueryOptions.Builder

addAllIdentifyingFields(Iterable<? extends FieldId> values)

public BigQueryOptions.Builder addAllIdentifyingFields(Iterable<? extends FieldId> values)

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Parameter
Name Description
values Iterable<? extends com.google.privacy.dlp.v2.FieldId>
Returns
Type Description
BigQueryOptions.Builder

addAllIncludedFields(Iterable<? extends FieldId> values)

public BigQueryOptions.Builder addAllIncludedFields(Iterable<? extends FieldId> values)

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Parameter
Name Description
values Iterable<? extends com.google.privacy.dlp.v2.FieldId>
Returns
Type Description
BigQueryOptions.Builder

addExcludedFields(FieldId value)

public BigQueryOptions.Builder addExcludedFields(FieldId value)

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Parameter
Name Description
value FieldId
Returns
Type Description
BigQueryOptions.Builder

addExcludedFields(FieldId.Builder builderForValue)

public BigQueryOptions.Builder addExcludedFields(FieldId.Builder builderForValue)

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Parameter
Name Description
builderForValue FieldId.Builder
Returns
Type Description
BigQueryOptions.Builder

addExcludedFields(int index, FieldId value)

public BigQueryOptions.Builder addExcludedFields(int index, FieldId value)

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Parameters
Name Description
index int
value FieldId
Returns
Type Description
BigQueryOptions.Builder

addExcludedFields(int index, FieldId.Builder builderForValue)

public BigQueryOptions.Builder addExcludedFields(int index, FieldId.Builder builderForValue)

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Parameters
Name Description
index int
builderForValue FieldId.Builder
Returns
Type Description
BigQueryOptions.Builder

addExcludedFieldsBuilder()

public FieldId.Builder addExcludedFieldsBuilder()

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Returns
Type Description
FieldId.Builder

addExcludedFieldsBuilder(int index)

public FieldId.Builder addExcludedFieldsBuilder(int index)

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Parameter
Name Description
index int
Returns
Type Description
FieldId.Builder

addIdentifyingFields(FieldId value)

public BigQueryOptions.Builder addIdentifyingFields(FieldId value)

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Parameter
Name Description
value FieldId
Returns
Type Description
BigQueryOptions.Builder

addIdentifyingFields(FieldId.Builder builderForValue)

public BigQueryOptions.Builder addIdentifyingFields(FieldId.Builder builderForValue)

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Parameter
Name Description
builderForValue FieldId.Builder
Returns
Type Description
BigQueryOptions.Builder

addIdentifyingFields(int index, FieldId value)

public BigQueryOptions.Builder addIdentifyingFields(int index, FieldId value)

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Parameters
Name Description
index int
value FieldId
Returns
Type Description
BigQueryOptions.Builder

addIdentifyingFields(int index, FieldId.Builder builderForValue)

public BigQueryOptions.Builder addIdentifyingFields(int index, FieldId.Builder builderForValue)

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Parameters
Name Description
index int
builderForValue FieldId.Builder
Returns
Type Description
BigQueryOptions.Builder

addIdentifyingFieldsBuilder()

public FieldId.Builder addIdentifyingFieldsBuilder()

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Returns
Type Description
FieldId.Builder

addIdentifyingFieldsBuilder(int index)

public FieldId.Builder addIdentifyingFieldsBuilder(int index)

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Parameter
Name Description
index int
Returns
Type Description
FieldId.Builder

addIncludedFields(FieldId value)

public BigQueryOptions.Builder addIncludedFields(FieldId value)

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Parameter
Name Description
value FieldId
Returns
Type Description
BigQueryOptions.Builder

addIncludedFields(FieldId.Builder builderForValue)

public BigQueryOptions.Builder addIncludedFields(FieldId.Builder builderForValue)

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Parameter
Name Description
builderForValue FieldId.Builder
Returns
Type Description
BigQueryOptions.Builder

addIncludedFields(int index, FieldId value)

public BigQueryOptions.Builder addIncludedFields(int index, FieldId value)

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Parameters
Name Description
index int
value FieldId
Returns
Type Description
BigQueryOptions.Builder

addIncludedFields(int index, FieldId.Builder builderForValue)

public BigQueryOptions.Builder addIncludedFields(int index, FieldId.Builder builderForValue)

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Parameters
Name Description
index int
builderForValue FieldId.Builder
Returns
Type Description
BigQueryOptions.Builder

addIncludedFieldsBuilder()

public FieldId.Builder addIncludedFieldsBuilder()

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Returns
Type Description
FieldId.Builder

addIncludedFieldsBuilder(int index)

public FieldId.Builder addIncludedFieldsBuilder(int index)

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Parameter
Name Description
index int
Returns
Type Description
FieldId.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BigQueryOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BigQueryOptions.Builder
Overrides

build()

public BigQueryOptions build()
Returns
Type Description
BigQueryOptions

buildPartial()

public BigQueryOptions buildPartial()
Returns
Type Description
BigQueryOptions

clear()

public BigQueryOptions.Builder clear()
Returns
Type Description
BigQueryOptions.Builder
Overrides

clearExcludedFields()

public BigQueryOptions.Builder clearExcludedFields()

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Returns
Type Description
BigQueryOptions.Builder

clearField(Descriptors.FieldDescriptor field)

public BigQueryOptions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BigQueryOptions.Builder
Overrides

clearIdentifyingFields()

public BigQueryOptions.Builder clearIdentifyingFields()

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Returns
Type Description
BigQueryOptions.Builder

clearIncludedFields()

public BigQueryOptions.Builder clearIncludedFields()

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Returns
Type Description
BigQueryOptions.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public BigQueryOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BigQueryOptions.Builder
Overrides

clearRowsLimit()

public BigQueryOptions.Builder clearRowsLimit()

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.

int64 rows_limit = 3;

Returns
Type Description
BigQueryOptions.Builder

This builder for chaining.

clearRowsLimitPercent()

public BigQueryOptions.Builder clearRowsLimitPercent()

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.

int32 rows_limit_percent = 6;

Returns
Type Description
BigQueryOptions.Builder

This builder for chaining.

clearSampleMethod()

public BigQueryOptions.Builder clearSampleMethod()

How to sample the data.

.google.privacy.dlp.v2.BigQueryOptions.SampleMethod sample_method = 4;

Returns
Type Description
BigQueryOptions.Builder

This builder for chaining.

clearTableReference()

public BigQueryOptions.Builder clearTableReference()

Complete BigQuery table reference.

.google.privacy.dlp.v2.BigQueryTable table_reference = 1;

Returns
Type Description
BigQueryOptions.Builder

clone()

public BigQueryOptions.Builder clone()
Returns
Type Description
BigQueryOptions.Builder
Overrides

getDefaultInstanceForType()

public BigQueryOptions getDefaultInstanceForType()
Returns
Type Description
BigQueryOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getExcludedFields(int index)

public FieldId getExcludedFields(int index)

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Parameter
Name Description
index int
Returns
Type Description
FieldId

getExcludedFieldsBuilder(int index)

public FieldId.Builder getExcludedFieldsBuilder(int index)

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Parameter
Name Description
index int
Returns
Type Description
FieldId.Builder

getExcludedFieldsBuilderList()

public List<FieldId.Builder> getExcludedFieldsBuilderList()

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Returns
Type Description
List<Builder>

getExcludedFieldsCount()

public int getExcludedFieldsCount()

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Returns
Type Description
int

getExcludedFieldsList()

public List<FieldId> getExcludedFieldsList()

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Returns
Type Description
List<FieldId>

getExcludedFieldsOrBuilder(int index)

public FieldIdOrBuilder getExcludedFieldsOrBuilder(int index)

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Parameter
Name Description
index int
Returns
Type Description
FieldIdOrBuilder

getExcludedFieldsOrBuilderList()

public List<? extends FieldIdOrBuilder> getExcludedFieldsOrBuilderList()

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Returns
Type Description
List<? extends com.google.privacy.dlp.v2.FieldIdOrBuilder>

getIdentifyingFields(int index)

public FieldId getIdentifyingFields(int index)

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Parameter
Name Description
index int
Returns
Type Description
FieldId

getIdentifyingFieldsBuilder(int index)

public FieldId.Builder getIdentifyingFieldsBuilder(int index)

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Parameter
Name Description
index int
Returns
Type Description
FieldId.Builder

getIdentifyingFieldsBuilderList()

public List<FieldId.Builder> getIdentifyingFieldsBuilderList()

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Returns
Type Description
List<Builder>

getIdentifyingFieldsCount()

public int getIdentifyingFieldsCount()

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Returns
Type Description
int

getIdentifyingFieldsList()

public List<FieldId> getIdentifyingFieldsList()

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Returns
Type Description
List<FieldId>

getIdentifyingFieldsOrBuilder(int index)

public FieldIdOrBuilder getIdentifyingFieldsOrBuilder(int index)

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Parameter
Name Description
index int
Returns
Type Description
FieldIdOrBuilder

getIdentifyingFieldsOrBuilderList()

public List<? extends FieldIdOrBuilder> getIdentifyingFieldsOrBuilderList()

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Returns
Type Description
List<? extends com.google.privacy.dlp.v2.FieldIdOrBuilder>

getIncludedFields(int index)

public FieldId getIncludedFields(int index)

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Parameter
Name Description
index int
Returns
Type Description
FieldId

getIncludedFieldsBuilder(int index)

public FieldId.Builder getIncludedFieldsBuilder(int index)

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Parameter
Name Description
index int
Returns
Type Description
FieldId.Builder

getIncludedFieldsBuilderList()

public List<FieldId.Builder> getIncludedFieldsBuilderList()

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Returns
Type Description
List<Builder>

getIncludedFieldsCount()

public int getIncludedFieldsCount()

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Returns
Type Description
int

getIncludedFieldsList()

public List<FieldId> getIncludedFieldsList()

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Returns
Type Description
List<FieldId>

getIncludedFieldsOrBuilder(int index)

public FieldIdOrBuilder getIncludedFieldsOrBuilder(int index)

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Parameter
Name Description
index int
Returns
Type Description
FieldIdOrBuilder

getIncludedFieldsOrBuilderList()

public List<? extends FieldIdOrBuilder> getIncludedFieldsOrBuilderList()

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Returns
Type Description
List<? extends com.google.privacy.dlp.v2.FieldIdOrBuilder>

getRowsLimit()

public long 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.

int64 rows_limit = 3;

Returns
Type Description
long

The rowsLimit.

getRowsLimitPercent()

public int 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.

Caution: A known issue is causing the rowsLimitPercent field to behave unexpectedly. We recommend using rowsLimit instead.

int32 rows_limit_percent = 6;

Returns
Type Description
int

The rowsLimitPercent.

getSampleMethod()

public BigQueryOptions.SampleMethod getSampleMethod()

How to sample the data.

.google.privacy.dlp.v2.BigQueryOptions.SampleMethod sample_method = 4;

Returns
Type Description
BigQueryOptions.SampleMethod

The sampleMethod.

getSampleMethodValue()

public int getSampleMethodValue()

How to sample the data.

.google.privacy.dlp.v2.BigQueryOptions.SampleMethod sample_method = 4;

Returns
Type Description
int

The enum numeric value on the wire for sampleMethod.

getTableReference()

public BigQueryTable getTableReference()

Complete BigQuery table reference.

.google.privacy.dlp.v2.BigQueryTable table_reference = 1;

Returns
Type Description
BigQueryTable

The tableReference.

getTableReferenceBuilder()

public BigQueryTable.Builder getTableReferenceBuilder()

Complete BigQuery table reference.

.google.privacy.dlp.v2.BigQueryTable table_reference = 1;

Returns
Type Description
BigQueryTable.Builder

getTableReferenceOrBuilder()

public BigQueryTableOrBuilder getTableReferenceOrBuilder()

Complete BigQuery table reference.

.google.privacy.dlp.v2.BigQueryTable table_reference = 1;

Returns
Type Description
BigQueryTableOrBuilder

hasTableReference()

public boolean hasTableReference()

Complete BigQuery table reference.

.google.privacy.dlp.v2.BigQueryTable table_reference = 1;

Returns
Type Description
boolean

Whether the tableReference field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BigQueryOptions other)

public BigQueryOptions.Builder mergeFrom(BigQueryOptions other)
Parameter
Name Description
other BigQueryOptions
Returns
Type Description
BigQueryOptions.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BigQueryOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQueryOptions.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BigQueryOptions.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BigQueryOptions.Builder
Overrides

mergeTableReference(BigQueryTable value)

public BigQueryOptions.Builder mergeTableReference(BigQueryTable value)

Complete BigQuery table reference.

.google.privacy.dlp.v2.BigQueryTable table_reference = 1;

Parameter
Name Description
value BigQueryTable
Returns
Type Description
BigQueryOptions.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BigQueryOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BigQueryOptions.Builder
Overrides

removeExcludedFields(int index)

public BigQueryOptions.Builder removeExcludedFields(int index)

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Parameter
Name Description
index int
Returns
Type Description
BigQueryOptions.Builder

removeIdentifyingFields(int index)

public BigQueryOptions.Builder removeIdentifyingFields(int index)

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Parameter
Name Description
index int
Returns
Type Description
BigQueryOptions.Builder

removeIncludedFields(int index)

public BigQueryOptions.Builder removeIncludedFields(int index)

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Parameter
Name Description
index int
Returns
Type Description
BigQueryOptions.Builder

setExcludedFields(int index, FieldId value)

public BigQueryOptions.Builder setExcludedFields(int index, FieldId value)

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Parameters
Name Description
index int
value FieldId
Returns
Type Description
BigQueryOptions.Builder

setExcludedFields(int index, FieldId.Builder builderForValue)

public BigQueryOptions.Builder setExcludedFields(int index, FieldId.Builder builderForValue)

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.

repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;

Parameters
Name Description
index int
builderForValue FieldId.Builder
Returns
Type Description
BigQueryOptions.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public BigQueryOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BigQueryOptions.Builder
Overrides

setIdentifyingFields(int index, FieldId value)

public BigQueryOptions.Builder setIdentifyingFields(int index, FieldId value)

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Parameters
Name Description
index int
value FieldId
Returns
Type Description
BigQueryOptions.Builder

setIdentifyingFields(int index, FieldId.Builder builderForValue)

public BigQueryOptions.Builder setIdentifyingFields(int index, FieldId.Builder builderForValue)

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.

repeated .google.privacy.dlp.v2.FieldId identifying_fields = 2;

Parameters
Name Description
index int
builderForValue FieldId.Builder
Returns
Type Description
BigQueryOptions.Builder

setIncludedFields(int index, FieldId value)

public BigQueryOptions.Builder setIncludedFields(int index, FieldId value)

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Parameters
Name Description
index int
value FieldId
Returns
Type Description
BigQueryOptions.Builder

setIncludedFields(int index, FieldId.Builder builderForValue)

public BigQueryOptions.Builder setIncludedFields(int index, FieldId.Builder builderForValue)

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.

repeated .google.privacy.dlp.v2.FieldId included_fields = 7;

Parameters
Name Description
index int
builderForValue FieldId.Builder
Returns
Type Description
BigQueryOptions.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BigQueryOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BigQueryOptions.Builder
Overrides

setRowsLimit(long value)

public BigQueryOptions.Builder setRowsLimit(long value)

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.

int64 rows_limit = 3;

Parameter
Name Description
value long

The rowsLimit to set.
Returns
Type Description
BigQueryOptions.Builder

This builder for chaining.

setRowsLimitPercent(int value)

public BigQueryOptions.Builder setRowsLimitPercent(int value)

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.

int32 rows_limit_percent = 6;

Parameter
Name Description
value int

The rowsLimitPercent to set.
Returns
Type Description
BigQueryOptions.Builder

This builder for chaining.

setSampleMethod(BigQueryOptions.SampleMethod value)

public BigQueryOptions.Builder setSampleMethod(BigQueryOptions.SampleMethod value)

How to sample the data.

.google.privacy.dlp.v2.BigQueryOptions.SampleMethod sample_method = 4;

Parameter
Name Description
value BigQueryOptions.SampleMethod

The sampleMethod to set.
Returns
Type Description
BigQueryOptions.Builder

This builder for chaining.

setSampleMethodValue(int value)

public BigQueryOptions.Builder setSampleMethodValue(int value)

How to sample the data.

.google.privacy.dlp.v2.BigQueryOptions.SampleMethod sample_method = 4;

Parameter
Name Description
value int

The enum numeric value on the wire for sampleMethod to set.
Returns
Type Description
BigQueryOptions.Builder

This builder for chaining.

setTableReference(BigQueryTable value)

public BigQueryOptions.Builder setTableReference(BigQueryTable value)

Complete BigQuery table reference.

.google.privacy.dlp.v2.BigQueryTable table_reference = 1;

Parameter
Name Description
value BigQueryTable
Returns
Type Description
BigQueryOptions.Builder

setTableReference(BigQueryTable.Builder builderForValue)

public BigQueryOptions.Builder setTableReference(BigQueryTable.Builder builderForValue)

Complete BigQuery table reference.

.google.privacy.dlp.v2.BigQueryTable table_reference = 1;

Parameter
Name Description
builderForValue BigQueryTable.Builder
Returns
Type Description
BigQueryOptions.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final BigQueryOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BigQueryOptions.Builder
Overrides