Class CloudStorageOptions (3.48.0)

public final class CloudStorageOptions extends GeneratedMessageV3 implements CloudStorageOptionsOrBuilder

Options defining a file or a set of files within a Cloud Storage bucket.

Protobuf type google.privacy.dlp.v2.CloudStorageOptions

Static Fields

BYTES_LIMIT_PER_FILE_FIELD_NUMBER

public static final int BYTES_LIMIT_PER_FILE_FIELD_NUMBER
Field Value
Type Description
int

BYTES_LIMIT_PER_FILE_PERCENT_FIELD_NUMBER

public static final int BYTES_LIMIT_PER_FILE_PERCENT_FIELD_NUMBER
Field Value
Type Description
int

FILES_LIMIT_PERCENT_FIELD_NUMBER

public static final int FILES_LIMIT_PERCENT_FIELD_NUMBER
Field Value
Type Description
int

FILE_SET_FIELD_NUMBER

public static final int FILE_SET_FIELD_NUMBER
Field Value
Type Description
int

FILE_TYPES_FIELD_NUMBER

public static final int FILE_TYPES_FIELD_NUMBER
Field Value
Type Description
int

SAMPLE_METHOD_FIELD_NUMBER

public static final int SAMPLE_METHOD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CloudStorageOptions getDefaultInstance()
Returns
Type Description
CloudStorageOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CloudStorageOptions.Builder newBuilder()
Returns
Type Description
CloudStorageOptions.Builder

newBuilder(CloudStorageOptions prototype)

public static CloudStorageOptions.Builder newBuilder(CloudStorageOptions prototype)
Parameter
Name Description
prototype CloudStorageOptions
Returns
Type Description
CloudStorageOptions.Builder

parseDelimitedFrom(InputStream input)

public static CloudStorageOptions parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CloudStorageOptions
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudStorageOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloudStorageOptions
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CloudStorageOptions parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CloudStorageOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CloudStorageOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloudStorageOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CloudStorageOptions parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CloudStorageOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CloudStorageOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloudStorageOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CloudStorageOptions parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CloudStorageOptions
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudStorageOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloudStorageOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CloudStorageOptions parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CloudStorageOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudStorageOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloudStorageOptions
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CloudStorageOptions parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CloudStorageOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CloudStorageOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloudStorageOptions
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CloudStorageOptions> parser()
Returns
Type Description
Parser<CloudStorageOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see Limits on bytes scanned per file.

int64 bytes_limit_per_file = 4;

Returns
Type Description
long

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. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see Limits on bytes scanned per file.

int32 bytes_limit_per_file_percent = 8;

Returns
Type Description
int

The bytesLimitPerFilePercent.

getDefaultInstanceForType()

public CloudStorageOptions getDefaultInstanceForType()
Returns
Type Description
CloudStorageOptions

getFileSet()

public CloudStorageOptions.FileSet getFileSet()

The set of one or more files to scan.

.google.privacy.dlp.v2.CloudStorageOptions.FileSet file_set = 1;

Returns
Type Description
CloudStorageOptions.FileSet

The fileSet.

getFileSetOrBuilder()

public CloudStorageOptions.FileSetOrBuilder getFileSetOrBuilder()

The set of one or more files to scan.

.google.privacy.dlp.v2.CloudStorageOptions.FileSet file_set = 1;

Returns
Type Description
CloudStorageOptions.FileSetOrBuilder

getFileTypes(int index)

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;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
FileType

The fileTypes at the given index.

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;

Returns
Type Description
int

The count of fileTypes.

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;

Returns
Type Description
List<FileType>

A list containing the fileTypes.

getFileTypesValue(int index)

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;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of 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;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for fileTypes.

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;

Returns
Type Description
int

The filesLimitPercent.

getParserForType()

public Parser<CloudStorageOptions> getParserForType()
Returns
Type Description
Parser<CloudStorageOptions>
Overrides

getSampleMethod()

public CloudStorageOptions.SampleMethod getSampleMethod()

How to sample the data.

.google.privacy.dlp.v2.CloudStorageOptions.SampleMethod sample_method = 6;

Returns
Type Description
CloudStorageOptions.SampleMethod

The sampleMethod.

getSampleMethodValue()

public int getSampleMethodValue()

How to sample the data.

.google.privacy.dlp.v2.CloudStorageOptions.SampleMethod sample_method = 6;

Returns
Type Description
int

The enum numeric value on the wire for sampleMethod.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasFileSet()

public boolean hasFileSet()

The set of one or more files to scan.

.google.privacy.dlp.v2.CloudStorageOptions.FileSet file_set = 1;

Returns
Type Description
boolean

Whether the fileSet field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CloudStorageOptions.Builder newBuilderForType()
Returns
Type Description
CloudStorageOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CloudStorageOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CloudStorageOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CloudStorageOptions.Builder toBuilder()
Returns
Type Description
CloudStorageOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException