Interface BigQueryOptionsOrBuilder (3.43.0)

Version 3.43.0

• 3.59.0 (latest)
• 3.58.0
• 3.57.0
• 3.56.0
• 3.55.0
• 3.53.0
• 3.52.0
• 3.51.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.6
• 3.6.7
• 3.5.0
• 3.4.0
• 3.3.2
• 3.2.1
• 3.1.4

public interface BigQueryOptionsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getExcludedFields(int index)

public abstract 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

getExcludedFieldsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getIdentifyingFieldsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getIncludedFieldsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract BigQueryTable getTableReference()

Complete BigQuery table reference.

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

Returns
Type	Description
BigQueryTable	The tableReference.

getTableReferenceOrBuilder()

public abstract BigQueryTableOrBuilder getTableReferenceOrBuilder()

Complete BigQuery table reference.

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

Returns
Type	Description
BigQueryTableOrBuilder

hasTableReference()

public abstract boolean hasTableReference()

Complete BigQuery table reference.

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

Returns
Type	Description
boolean	Whether the tableReference field is set.