Class BigQueryOptions (3.4.0)

Version 3.4.0

• 3.45.0 (latest)
• 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 final class BigQueryOptions extends GeneratedMessageV3 implements BigQueryOptionsOrBuilder

Options defining BigQuery table and row identifiers.

Protobuf type google.privacy.dlp.v2.BigQueryOptions

Inheritance

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

Implements

BigQueryOptionsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

EXCLUDED_FIELDS_FIELD_NUMBER

public static final int EXCLUDED_FIELDS_FIELD_NUMBER

Field Value

Type	Description
int

IDENTIFYING_FIELDS_FIELD_NUMBER

public static final int IDENTIFYING_FIELDS_FIELD_NUMBER

Field Value

Type	Description
int

INCLUDED_FIELDS_FIELD_NUMBER

public static final int INCLUDED_FIELDS_FIELD_NUMBER

Field Value

Type	Description
int

ROWS_LIMIT_FIELD_NUMBER

public static final int ROWS_LIMIT_FIELD_NUMBER

Field Value

Type	Description
int

ROWS_LIMIT_PERCENT_FIELD_NUMBER

public static final int ROWS_LIMIT_PERCENT_FIELD_NUMBER

Field Value

Type	Description
int

SAMPLE_METHOD_FIELD_NUMBER

public static final int SAMPLE_METHOD_FIELD_NUMBER

Field Value

Type	Description
int

TABLE_REFERENCE_FIELD_NUMBER

public static final int TABLE_REFERENCE_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static BigQueryOptions getDefaultInstance()

Returns

Type	Description
BigQueryOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static BigQueryOptions.Builder newBuilder()

Returns

Type	Description
BigQueryOptions.Builder

newBuilder(BigQueryOptions prototype)

public static BigQueryOptions.Builder newBuilder(BigQueryOptions prototype)

Parameter

Name	Description
prototype	BigQueryOptions

Returns

Type	Description
BigQueryOptions.Builder

parseDelimitedFrom(InputStream input)

public static BigQueryOptions parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
BigQueryOptions

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BigQueryOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
BigQueryOptions

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static BigQueryOptions parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
BigQueryOptions

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BigQueryOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
BigQueryOptions

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BigQueryOptions parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
BigQueryOptions

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BigQueryOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
BigQueryOptions

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BigQueryOptions parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
BigQueryOptions

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BigQueryOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
BigQueryOptions

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static BigQueryOptions parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
BigQueryOptions

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BigQueryOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
BigQueryOptions

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static BigQueryOptions parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
BigQueryOptions

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BigQueryOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
BigQueryOptions

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<BigQueryOptions> parser()

Returns

Type	Description
Parser<BigQueryOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public BigQueryOptions getDefaultInstanceForType()

Returns

Type	Description
BigQueryOptions

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.

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

Parameter

Name	Description
index	int

Returns

Type	Description
FieldId

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.

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.

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.

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.

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

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.

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

Parameter

Name	Description
index	int

Returns

Type	Description
FieldId

getIncludedFieldsCount()

public int getIncludedFieldsCount()

Limit scanning only to these fields.

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

Returns

Type	Description
int

getIncludedFieldsList()

public List<FieldId> getIncludedFieldsList()

Limit scanning only to these fields.

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.

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.

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

Returns

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

getParserForType()

public Parser<BigQueryOptions> getParserForType()

Returns

Type	Description
Parser<BigQueryOptions>

Overrides

GeneratedMessageV3.getParserForType()

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.

int32 rows_limit_percent = 6;

Returns

Type	Description
int	The rowsLimitPercent.

getSampleMethod()

public BigQueryOptions.SampleMethod getSampleMethod()

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

Returns

Type	Description
BigQueryOptions.SampleMethod	The sampleMethod.

getSampleMethodValue()

public int getSampleMethodValue()

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

Returns

Type	Description
int	The enum numeric value on the wire for sampleMethod.

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getTableReference()

public BigQueryTable getTableReference()

Complete BigQuery table reference.

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

Returns

Type	Description
BigQueryTable	The tableReference.

getTableReferenceOrBuilder()

public BigQueryTableOrBuilder getTableReferenceOrBuilder()

Complete BigQuery table reference.

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

Returns

Type	Description
BigQueryTableOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public BigQueryOptions.Builder newBuilderForType()

Returns

Type	Description
BigQueryOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BigQueryOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
BigQueryOptions.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public BigQueryOptions.Builder toBuilder()

Returns

Type	Description
BigQueryOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException