public final class BigQueryOptions extends GeneratedMessageV3 implements BigQueryOptionsOrBuilder
Options defining BigQuery table and row identifiers.
Protobuf type google.privacy.dlp.v2.BigQueryOptions
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BigQueryOptions.Builder newBuilder()
newBuilder(BigQueryOptions prototype)
public static BigQueryOptions.Builder newBuilder(BigQueryOptions prototype)
public static BigQueryOptions parseDelimitedFrom(InputStream input)
public static BigQueryOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BigQueryOptions parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BigQueryOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BigQueryOptions parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BigQueryOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BigQueryOptions parseFrom(CodedInputStream input)
public static BigQueryOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BigQueryOptions parseFrom(InputStream input)
public static BigQueryOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BigQueryOptions parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BigQueryOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BigQueryOptions> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public BigQueryOptions getDefaultInstanceForType()
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
|
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;
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
|
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
|
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;
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
|
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
|
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;
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
|
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> |
|
getParserForType()
public Parser<BigQueryOptions> getParserForType()
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 |
| 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;
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTableReference()
public BigQueryTable getTableReference()
Complete BigQuery table reference.
.google.privacy.dlp.v2.BigQueryTable table_reference = 1;
getTableReferenceOrBuilder()
public BigQueryTableOrBuilder getTableReferenceOrBuilder()
Complete BigQuery table reference.
.google.privacy.dlp.v2.BigQueryTable table_reference = 1;
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public BigQueryOptions.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BigQueryOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public BigQueryOptions.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
