Class CloudStorageOptions

public final class CloudStorageOptions extends GeneratedMessageV3 implements CloudStorageOptionsOrBuilder

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

Protobuf type google.privacy.dlp.v2.CloudStorageOptions

Fields

BYTES_LIMIT_PER_FILE_FIELD_NUMBER

public static final int BYTES_LIMIT_PER_FILE_FIELD_NUMBER
Field Value
TypeDescription
int

BYTES_LIMIT_PER_FILE_PERCENT_FIELD_NUMBER

public static final int BYTES_LIMIT_PER_FILE_PERCENT_FIELD_NUMBER
Field Value
TypeDescription
int

FILES_LIMIT_PERCENT_FIELD_NUMBER

public static final int FILES_LIMIT_PERCENT_FIELD_NUMBER
Field Value
TypeDescription
int

FILE_SET_FIELD_NUMBER

public static final int FILE_SET_FIELD_NUMBER
Field Value
TypeDescription
int

FILE_TYPES_FIELD_NUMBER

public static final int FILE_TYPES_FIELD_NUMBER
Field Value
TypeDescription
int

SAMPLE_METHOD_FIELD_NUMBER

public static final int SAMPLE_METHOD_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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. Cannot be set if de-identification is requested.

int64 bytes_limit_per_file = 4;

Returns
TypeDescription
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. Cannot be set if de-identification is requested.

int32 bytes_limit_per_file_percent = 8;

Returns
TypeDescription
int

The bytesLimitPerFilePercent.

getDefaultInstance()

public static CloudStorageOptions getDefaultInstance()
Returns
TypeDescription
CloudStorageOptions

getDefaultInstanceForType()

public CloudStorageOptions getDefaultInstanceForType()
Returns
TypeDescription
CloudStorageOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getFileSet()

public CloudStorageOptions.FileSet getFileSet()

The set of one or more files to scan.

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

Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The filesLimitPercent.

getParserForType()

public Parser<CloudStorageOptions> getParserForType()
Returns
TypeDescription
Parser<CloudStorageOptions>
Overrides

getSampleMethod()

public CloudStorageOptions.SampleMethod getSampleMethod()

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

Returns
TypeDescription
CloudStorageOptions.SampleMethod

The sampleMethod.

getSampleMethodValue()

public int getSampleMethodValue()

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

Returns
TypeDescription
int

The enum numeric value on the wire for sampleMethod.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasFileSet()

public boolean hasFileSet()

The set of one or more files to scan.

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

Returns
TypeDescription
boolean

Whether the fileSet field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static CloudStorageOptions.Builder newBuilder()
Returns
TypeDescription
CloudStorageOptions.Builder

newBuilder(CloudStorageOptions prototype)

public static CloudStorageOptions.Builder newBuilder(CloudStorageOptions prototype)
Parameter
NameDescription
prototypeCloudStorageOptions
Returns
TypeDescription
CloudStorageOptions.Builder

newBuilderForType()

public CloudStorageOptions.Builder newBuilderForType()
Returns
TypeDescription
CloudStorageOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CloudStorageOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CloudStorageOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static CloudStorageOptions parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CloudStorageOptions
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudStorageOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudStorageOptions
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CloudStorageOptions parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CloudStorageOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CloudStorageOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudStorageOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CloudStorageOptions parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CloudStorageOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CloudStorageOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudStorageOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CloudStorageOptions parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CloudStorageOptions
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudStorageOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudStorageOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CloudStorageOptions parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CloudStorageOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudStorageOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudStorageOptions
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CloudStorageOptions parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CloudStorageOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CloudStorageOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudStorageOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CloudStorageOptions> parser()
Returns
TypeDescription
Parser<CloudStorageOptions>

toBuilder()

public CloudStorageOptions.Builder toBuilder()
Returns
TypeDescription
CloudStorageOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException