Class BigQueryOptions (3.6.7)

Stay organized with collections Save and categorize content based on your preferences.
public final class BigQueryOptions extends GeneratedMessageV3 implements BigQueryOptionsOrBuilder

Options defining BigQuery table and row identifiers.

Protobuf type google.privacy.dlp.v2.BigQueryOptions

Static Fields

EXCLUDED_FIELDS_FIELD_NUMBER

public static final int EXCLUDED_FIELDS_FIELD_NUMBER
Field Value
TypeDescription
int

IDENTIFYING_FIELDS_FIELD_NUMBER

public static final int IDENTIFYING_FIELDS_FIELD_NUMBER
Field Value
TypeDescription
int

INCLUDED_FIELDS_FIELD_NUMBER

public static final int INCLUDED_FIELDS_FIELD_NUMBER
Field Value
TypeDescription
int

ROWS_LIMIT_FIELD_NUMBER

public static final int ROWS_LIMIT_FIELD_NUMBER
Field Value
TypeDescription
int

ROWS_LIMIT_PERCENT_FIELD_NUMBER

public static final int ROWS_LIMIT_PERCENT_FIELD_NUMBER
Field Value
TypeDescription
int

SAMPLE_METHOD_FIELD_NUMBER

public static final int SAMPLE_METHOD_FIELD_NUMBER
Field Value
TypeDescription
int

TABLE_REFERENCE_FIELD_NUMBER

public static final int TABLE_REFERENCE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BigQueryOptions getDefaultInstance()
Returns
TypeDescription
BigQueryOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static BigQueryOptions.Builder newBuilder()
Returns
TypeDescription
BigQueryOptions.Builder

newBuilder(BigQueryOptions prototype)

public static BigQueryOptions.Builder newBuilder(BigQueryOptions prototype)
Parameter
NameDescription
prototypeBigQueryOptions
Returns
TypeDescription
BigQueryOptions.Builder

parseDelimitedFrom(InputStream input)

public static BigQueryOptions parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BigQueryOptions
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BigQueryOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BigQueryOptions
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static BigQueryOptions parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
BigQueryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BigQueryOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BigQueryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BigQueryOptions parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BigQueryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BigQueryOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BigQueryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BigQueryOptions parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BigQueryOptions
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BigQueryOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BigQueryOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static BigQueryOptions parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BigQueryOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BigQueryOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BigQueryOptions
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static BigQueryOptions parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BigQueryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BigQueryOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BigQueryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<BigQueryOptions> parser()
Returns
TypeDescription
Parser<BigQueryOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public BigQueryOptions getDefaultInstanceForType()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
FieldId

getIncludedFieldsCount()

public int getIncludedFieldsCount()

Limit scanning only to these fields.

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

Returns
TypeDescription
int

getIncludedFieldsList()

public List<FieldId> getIncludedFieldsList()

Limit scanning only to these fields.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
FieldIdOrBuilder

getIncludedFieldsOrBuilderList()

public List<? extends FieldIdOrBuilder> getIncludedFieldsOrBuilderList()

Limit scanning only to these fields.

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

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

getParserForType()

public Parser<BigQueryOptions> getParserForType()
Returns
TypeDescription
Parser<BigQueryOptions>
Overrides

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
TypeDescription
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
TypeDescription
int

The rowsLimitPercent.

getSampleMethod()

public BigQueryOptions.SampleMethod getSampleMethod()

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

Returns
TypeDescription
BigQueryOptions.SampleMethod

The sampleMethod.

getSampleMethodValue()

public int getSampleMethodValue()

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

Returns
TypeDescription
int

The enum numeric value on the wire for sampleMethod.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTableReference()

public BigQueryTable getTableReference()

Complete BigQuery table reference.

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

Returns
TypeDescription
BigQueryTable

The tableReference.

getTableReferenceOrBuilder()

public BigQueryTableOrBuilder getTableReferenceOrBuilder()

Complete BigQuery table reference.

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

Returns
TypeDescription
BigQueryTableOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasTableReference()

public boolean hasTableReference()

Complete BigQuery table reference.

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

Returns
TypeDescription
boolean

Whether the tableReference field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public BigQueryOptions.Builder newBuilderForType()
Returns
TypeDescription
BigQueryOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BigQueryOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
BigQueryOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public BigQueryOptions.Builder toBuilder()
Returns
TypeDescription
BigQueryOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException