Package com.google.privacy.dlp.v2

Class BigQueryOptions

  • All Implemented Interfaces:
    BigQueryOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class BigQueryOptions
extends com.google.protobuf.GeneratedMessageV3
implements BigQueryOptionsOrBuilder
     Options defining BigQuery table and row identifiers.
    Protobuf type google.privacy.dlp.v2.BigQueryOptions
    See Also:
    Serialized Form

    • Field Detail

      • TABLE_REFERENCE_FIELD_NUMBER

        public static final int TABLE_REFERENCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IDENTIFYING_FIELDS_FIELD_NUMBER

        public static final int IDENTIFYING_FIELDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ROWS_LIMIT_FIELD_NUMBER

        public static final int ROWS_LIMIT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ROWS_LIMIT_PERCENT_FIELD_NUMBER

        public static final int ROWS_LIMIT_PERCENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SAMPLE_METHOD_FIELD_NUMBER

        public static final int SAMPLE_METHOD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXCLUDED_FIELDS_FIELD_NUMBER

        public static final int EXCLUDED_FIELDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INCLUDED_FIELDS_FIELD_NUMBER

        public static final int INCLUDED_FIELDS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • 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.

      • 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.
        int32 rows_limit_percent = 6;
        Specified by:
        getRowsLimitPercent in interface BigQueryOptionsOrBuilder
        Returns:
        The rowsLimitPercent.

      • getSampleMethodValue

        public int getSampleMethodValue()
        .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.

      • 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;
        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.
        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.
        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.
        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.
        repeated .google.privacy.dlp.v2.FieldId excluded_fields = 5;
        Specified by:
        getExcludedFieldsOrBuilder in interface BigQueryOptionsOrBuilder

      • getIncludedFieldsCount

        public int getIncludedFieldsCount()
         Limit scanning only to these fields.
        repeated .google.privacy.dlp.v2.FieldId included_fields = 7;
        Specified by:
        getIncludedFieldsCount in interface BigQueryOptionsOrBuilder

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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​(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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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