Class CloudStorageOptions

  • All Implemented Interfaces:
    CloudStorageOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class CloudStorageOptions
    extends com.google.protobuf.GeneratedMessageV3
    implements CloudStorageOptionsOrBuilder
     Options defining a file or a set of files within a Cloud Storage
     bucket.
     
    Protobuf type google.privacy.dlp.v2.CloudStorageOptions
    See Also:
    Serialized Form
    • Field Detail

      • BYTES_LIMIT_PER_FILE_FIELD_NUMBER

        public static final int BYTES_LIMIT_PER_FILE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • BYTES_LIMIT_PER_FILE_PERCENT_FIELD_NUMBER

        public static final int BYTES_LIMIT_PER_FILE_PERCENT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • FILE_TYPES_FIELD_NUMBER

        public static final int FILE_TYPES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SAMPLE_METHOD_FIELD_NUMBER

        public static final int SAMPLE_METHOD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • FILES_LIMIT_PERCENT_FIELD_NUMBER

        public static final int FILES_LIMIT_PERCENT_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
      • hasFileSet

        public boolean hasFileSet()
         The set of one or more files to scan.
         
        .google.privacy.dlp.v2.CloudStorageOptions.FileSet file_set = 1;
        Specified by:
        hasFileSet in interface CloudStorageOptionsOrBuilder
        Returns:
        Whether the fileSet field is set.
      • getBytesLimitPerFile

        public long getBytesLimitPerFile()
         Max number of bytes to scan from a file. If a scanned file's size is bigger
         than this value then the rest of the bytes are omitted. Only one
         of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.
         Cannot be set if de-identification is requested.
         
        int64 bytes_limit_per_file = 4;
        Specified by:
        getBytesLimitPerFile in interface CloudStorageOptionsOrBuilder
        Returns:
        The bytesLimitPerFile.
      • getBytesLimitPerFilePercent

        public int getBytesLimitPerFilePercent()
         Max percentage of bytes to scan from a file. The rest are omitted. The
         number of bytes scanned is rounded down. Must be between 0 and 100,
         inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one
         of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.
         Cannot be set if de-identification is requested.
         
        int32 bytes_limit_per_file_percent = 8;
        Specified by:
        getBytesLimitPerFilePercent in interface CloudStorageOptionsOrBuilder
        Returns:
        The bytesLimitPerFilePercent.
      • getFileTypesList

        public List<FileType> getFileTypesList()
         List of file type groups to include in the scan.
         If empty, all files are scanned and available data format processors
         are applied. In addition, the binary content of the selected files
         is always scanned as well.
         Images are scanned only as binary if the specified region
         does not support image inspection and no file_types were specified.
         Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.
         
        repeated .google.privacy.dlp.v2.FileType file_types = 5;
        Specified by:
        getFileTypesList in interface CloudStorageOptionsOrBuilder
        Returns:
        A list containing the fileTypes.
      • getFileTypesCount

        public int getFileTypesCount()
         List of file type groups to include in the scan.
         If empty, all files are scanned and available data format processors
         are applied. In addition, the binary content of the selected files
         is always scanned as well.
         Images are scanned only as binary if the specified region
         does not support image inspection and no file_types were specified.
         Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.
         
        repeated .google.privacy.dlp.v2.FileType file_types = 5;
        Specified by:
        getFileTypesCount in interface CloudStorageOptionsOrBuilder
        Returns:
        The count of fileTypes.
      • getFileTypes

        public FileType getFileTypes​(int index)
         List of file type groups to include in the scan.
         If empty, all files are scanned and available data format processors
         are applied. In addition, the binary content of the selected files
         is always scanned as well.
         Images are scanned only as binary if the specified region
         does not support image inspection and no file_types were specified.
         Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.
         
        repeated .google.privacy.dlp.v2.FileType file_types = 5;
        Specified by:
        getFileTypes in interface CloudStorageOptionsOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The fileTypes at the given index.
      • getFileTypesValueList

        public List<Integer> getFileTypesValueList()
         List of file type groups to include in the scan.
         If empty, all files are scanned and available data format processors
         are applied. In addition, the binary content of the selected files
         is always scanned as well.
         Images are scanned only as binary if the specified region
         does not support image inspection and no file_types were specified.
         Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.
         
        repeated .google.privacy.dlp.v2.FileType file_types = 5;
        Specified by:
        getFileTypesValueList in interface CloudStorageOptionsOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for fileTypes.
      • getFileTypesValue

        public int getFileTypesValue​(int index)
         List of file type groups to include in the scan.
         If empty, all files are scanned and available data format processors
         are applied. In addition, the binary content of the selected files
         is always scanned as well.
         Images are scanned only as binary if the specified region
         does not support image inspection and no file_types were specified.
         Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.
         
        repeated .google.privacy.dlp.v2.FileType file_types = 5;
        Specified by:
        getFileTypesValue in interface CloudStorageOptionsOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of fileTypes at the given index.
      • getSampleMethodValue

        public int getSampleMethodValue()
        .google.privacy.dlp.v2.CloudStorageOptions.SampleMethod sample_method = 6;
        Specified by:
        getSampleMethodValue in interface CloudStorageOptionsOrBuilder
        Returns:
        The enum numeric value on the wire for sampleMethod.
      • getFilesLimitPercent

        public int getFilesLimitPercent()
         Limits the number of files to scan to this percentage of the input FileSet.
         Number of files scanned is rounded down. Must be between 0 and 100,
         inclusively. Both 0 and 100 means no limit. Defaults to 0.
         
        int32 files_limit_percent = 7;
        Specified by:
        getFilesLimitPercent in interface CloudStorageOptionsOrBuilder
        Returns:
        The filesLimitPercent.
      • 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 CloudStorageOptions parseFrom​(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static CloudStorageOptions parseFrom​(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        public static CloudStorageOptions parseFrom​(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

        protected CloudStorageOptions.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<CloudStorageOptions> 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 CloudStorageOptions getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder