Package com.google.privacy.dlp.v2

Class BigQueryOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.privacy.dlp.v2.BigQueryOptions
All Implemented Interfaces:
BigQueryOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class BigQueryOptions extends com.google.protobuf.GeneratedMessage implements BigQueryOptionsOrBuilder
 Options defining BigQuery table and row identifiers.
Protobuf type google.privacy.dlp.v2.BigQueryOptions
See Also:

  • Field Details

    • TABLE_REFERENCE_FIELD_NUMBER

      public static final int TABLE_REFERENCE_FIELD_NUMBER
      See Also:

    • IDENTIFYING_FIELDS_FIELD_NUMBER

      public static final int IDENTIFYING_FIELDS_FIELD_NUMBER
      See Also:

    • ROWS_LIMIT_FIELD_NUMBER

      public static final int ROWS_LIMIT_FIELD_NUMBER
      See Also:

    • ROWS_LIMIT_PERCENT_FIELD_NUMBER

      public static final int ROWS_LIMIT_PERCENT_FIELD_NUMBER
      See Also:

    • SAMPLE_METHOD_FIELD_NUMBER

      public static final int SAMPLE_METHOD_FIELD_NUMBER
      See Also:

    • EXCLUDED_FIELDS_FIELD_NUMBER

      public static final int EXCLUDED_FIELDS_FIELD_NUMBER
      See Also:

    • INCLUDED_FIELDS_FIELD_NUMBER

      public static final int INCLUDED_FIELDS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasTableReference

      public boolean hasTableReference()
       Complete BigQuery table reference.
      .google.privacy.dlp.v2.BigQueryTable table_reference = 1;
      Specified by:
      hasTableReference in interface BigQueryOptionsOrBuilder
      Returns:
      Whether the tableReference field is set.

    • getTableReference

      public BigQueryTable getTableReference()
       Complete BigQuery table reference.
      .google.privacy.dlp.v2.BigQueryTable table_reference = 1;
      Specified by:
      getTableReference in interface BigQueryOptionsOrBuilder
      Returns:
      The tableReference.

    • getTableReferenceOrBuilder

      public BigQueryTableOrBuilder getTableReferenceOrBuilder()
       Complete BigQuery table reference.
      .google.privacy.dlp.v2.BigQueryTable table_reference = 1;
      Specified by:
      getTableReferenceOrBuilder in interface BigQueryOptionsOrBuilder

    • 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;
      Specified by:
      getIdentifyingFieldsList in interface BigQueryOptionsOrBuilder

    • 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;
      Specified by:
      getIdentifyingFieldsOrBuilderList in interface BigQueryOptionsOrBuilder

    • 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;
      Specified by:
      getIdentifyingFieldsCount in interface BigQueryOptionsOrBuilder

    • getIdentifyingFields

      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;
      Specified by:
      getIdentifyingFields in interface BigQueryOptionsOrBuilder

    • getIdentifyingFieldsOrBuilder

      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;
      Specified by:
      getIdentifyingFieldsOrBuilder in interface BigQueryOptionsOrBuilder

    • 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;
      Specified by:
      getRowsLimit in interface BigQueryOptionsOrBuilder
      Returns:
      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](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling)
 is causing the `rowsLimitPercent` field to behave unexpectedly. We
 recommend using `rowsLimit` instead.
      int32 rows_limit_percent = 6;
      Specified by:
      getRowsLimitPercent in interface BigQueryOptionsOrBuilder
      Returns:
      The rowsLimitPercent.

    • getSampleMethodValue

      public int getSampleMethodValue()
       How to sample the data.
      .google.privacy.dlp.v2.BigQueryOptions.SampleMethod sample_method = 4;
      Specified by:
      getSampleMethodValue in interface BigQueryOptionsOrBuilder
      Returns:
      The enum numeric value on the wire for sampleMethod.

    • getSampleMethod

      public BigQueryOptions.SampleMethod getSampleMethod()
       How to sample the data.
      .google.privacy.dlp.v2.BigQueryOptions.SampleMethod sample_method = 4;
      Specified by:
      getSampleMethod in interface BigQueryOptionsOrBuilder
      Returns:
      The sampleMethod.

    • 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;
      Specified by:
      getExcludedFieldsList in interface BigQueryOptionsOrBuilder

    • 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;
      Specified by:
      getExcludedFieldsOrBuilderList in interface BigQueryOptionsOrBuilder

    • 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;
      Specified by:
      getExcludedFieldsCount in interface BigQueryOptionsOrBuilder

    • getExcludedFields

      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;
      Specified by:
      getExcludedFields in interface BigQueryOptionsOrBuilder

    • getExcludedFieldsOrBuilder

      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;
      Specified by:
      getExcludedFieldsOrBuilder in interface BigQueryOptionsOrBuilder

    • 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;
      Specified by:
      getIncludedFieldsList in interface BigQueryOptionsOrBuilder

    • 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;
      Specified by:
      getIncludedFieldsOrBuilderList in interface BigQueryOptionsOrBuilder

    • 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;
      Specified by:
      getIncludedFieldsCount in interface BigQueryOptionsOrBuilder

    • getIncludedFields

      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;
      Specified by:
      getIncludedFields in interface BigQueryOptionsOrBuilder

    • getIncludedFieldsOrBuilder

      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;
      Specified by:
      getIncludedFieldsOrBuilder in interface BigQueryOptionsOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static BigQueryOptions parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BigQueryOptions parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BigQueryOptions parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BigQueryOptions parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BigQueryOptions parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BigQueryOptions parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BigQueryOptions parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BigQueryOptions parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BigQueryOptions parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BigQueryOptions parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BigQueryOptions parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BigQueryOptions parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public BigQueryOptions.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static BigQueryOptions.Builder newBuilder()

    • newBuilder

      public static BigQueryOptions.Builder newBuilder(BigQueryOptions prototype)

    • toBuilder

      public BigQueryOptions.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected BigQueryOptions.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static BigQueryOptions getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<BigQueryOptions> parser()

    • getParserForType

      public com.google.protobuf.Parser<BigQueryOptions> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public BigQueryOptions getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder