Class CloudStorageOptions.Builder (3.53.0) 

public static final class CloudStorageOptions.Builder extends GeneratedMessageV3.Builder<CloudStorageOptions.Builder> implements CloudStorageOptionsOrBuilder

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

Protobuf type google.privacy.dlp.v2.CloudStorageOptions

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CloudStorageOptions.Builder

Static Methods

getDescriptor()

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

Methods

addAllFileTypes(Iterable<? extends FileType> values)

public CloudStorageOptions.Builder addAllFileTypes(Iterable<? extends FileType> values)

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
values Iterable<? extends com.google.privacy.dlp.v2.FileType>

The fileTypes to add.
Returns
Type Description
CloudStorageOptions.Builder

This builder for chaining.

addAllFileTypesValue(Iterable<Integer> values)

public CloudStorageOptions.Builder addAllFileTypesValue(Iterable<Integer> values)

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
values Iterable<Integer>

The enum numeric values on the wire for fileTypes to add.
Returns
Type Description
CloudStorageOptions.Builder

This builder for chaining.

addFileTypes(FileType value)

public CloudStorageOptions.Builder addFileTypes(FileType value)

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
value FileType

The fileTypes to add.
Returns
Type Description
CloudStorageOptions.Builder

This builder for chaining.

addFileTypesValue(int value)

public CloudStorageOptions.Builder addFileTypesValue(int value)

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
value int

The enum numeric value on the wire for fileTypes to add.
Returns
Type Description
CloudStorageOptions.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CloudStorageOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CloudStorageOptions.Builder
Overrides

build()

public CloudStorageOptions build()
Returns
Type Description
CloudStorageOptions

buildPartial()

public CloudStorageOptions buildPartial()
Returns
Type Description
CloudStorageOptions

clear()

public CloudStorageOptions.Builder clear()
Returns
Type Description
CloudStorageOptions.Builder
Overrides

clearBytesLimitPerFile()

public CloudStorageOptions.Builder clearBytesLimitPerFile()

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
CloudStorageOptions.Builder

This builder for chaining.

clearBytesLimitPerFilePercent()

public CloudStorageOptions.Builder clearBytesLimitPerFilePercent()

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
CloudStorageOptions.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CloudStorageOptions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CloudStorageOptions.Builder
Overrides

clearFileSet()

public CloudStorageOptions.Builder clearFileSet()

The set of one or more files to scan.

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

Returns
Type Description
CloudStorageOptions.Builder

clearFileTypes()

public CloudStorageOptions.Builder clearFileTypes()

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
CloudStorageOptions.Builder

This builder for chaining.

clearFilesLimitPercent()

public CloudStorageOptions.Builder clearFilesLimitPercent()

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
CloudStorageOptions.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CloudStorageOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CloudStorageOptions.Builder
Overrides

clearSampleMethod()

public CloudStorageOptions.Builder clearSampleMethod()

How to sample the data.

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

Returns
Type Description
CloudStorageOptions.Builder

This builder for chaining.

clone()

public CloudStorageOptions.Builder clone()
Returns
Type Description
CloudStorageOptions.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getFileSetBuilder()

public CloudStorageOptions.FileSet.Builder getFileSetBuilder()

The set of one or more files to scan.

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

Returns
Type Description
CloudStorageOptions.FileSet.Builder

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.

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFileSet(CloudStorageOptions.FileSet value)

public CloudStorageOptions.Builder mergeFileSet(CloudStorageOptions.FileSet value)

The set of one or more files to scan.

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

Parameter
Name Description
value CloudStorageOptions.FileSet
Returns
Type Description
CloudStorageOptions.Builder

mergeFrom(CloudStorageOptions other)

public CloudStorageOptions.Builder mergeFrom(CloudStorageOptions other)
Parameter
Name Description
other CloudStorageOptions
Returns
Type Description
CloudStorageOptions.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CloudStorageOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloudStorageOptions.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CloudStorageOptions.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CloudStorageOptions.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CloudStorageOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CloudStorageOptions.Builder
Overrides

setBytesLimitPerFile(long value)

public CloudStorageOptions.Builder setBytesLimitPerFile(long value)

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;

Parameter
Name Description
value long

The bytesLimitPerFile to set.
Returns
Type Description
CloudStorageOptions.Builder

This builder for chaining.

setBytesLimitPerFilePercent(int value)

public CloudStorageOptions.Builder setBytesLimitPerFilePercent(int value)

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;

Parameter
Name Description
value int

The bytesLimitPerFilePercent to set.
Returns
Type Description
CloudStorageOptions.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CloudStorageOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CloudStorageOptions.Builder
Overrides

setFileSet(CloudStorageOptions.FileSet value)

public CloudStorageOptions.Builder setFileSet(CloudStorageOptions.FileSet value)

The set of one or more files to scan.

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

Parameter
Name Description
value CloudStorageOptions.FileSet
Returns
Type Description
CloudStorageOptions.Builder

setFileSet(CloudStorageOptions.FileSet.Builder builderForValue)

public CloudStorageOptions.Builder setFileSet(CloudStorageOptions.FileSet.Builder builderForValue)

The set of one or more files to scan.

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

Parameter
Name Description
builderForValue CloudStorageOptions.FileSet.Builder
Returns
Type Description
CloudStorageOptions.Builder

setFileTypes(int index, FileType value)

public CloudStorageOptions.Builder setFileTypes(int index, FileType value)

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;

Parameters
Name Description
index int

The index to set the value at.
value FileType

The fileTypes to set.
Returns
Type Description
CloudStorageOptions.Builder

This builder for chaining.

setFileTypesValue(int index, int value)

public CloudStorageOptions.Builder setFileTypesValue(int index, int value)

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;

Parameters
Name Description
index int

The index to set the value at.
value int

The enum numeric value on the wire for fileTypes to set.
Returns
Type Description
CloudStorageOptions.Builder

This builder for chaining.

setFilesLimitPercent(int value)

public CloudStorageOptions.Builder setFilesLimitPercent(int value)

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;

Parameter
Name Description
value int

The filesLimitPercent to set.
Returns
Type Description
CloudStorageOptions.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CloudStorageOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CloudStorageOptions.Builder
Overrides

setSampleMethod(CloudStorageOptions.SampleMethod value)

public CloudStorageOptions.Builder setSampleMethod(CloudStorageOptions.SampleMethod value)

How to sample the data.

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

Parameter
Name Description
value CloudStorageOptions.SampleMethod

The sampleMethod to set.
Returns
Type Description
CloudStorageOptions.Builder

This builder for chaining.

setSampleMethodValue(int value)

public CloudStorageOptions.Builder setSampleMethodValue(int value)

How to sample the data.

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

Parameter
Name Description
value int

The enum numeric value on the wire for sampleMethod to set.
Returns
Type Description
CloudStorageOptions.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CloudStorageOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CloudStorageOptions.Builder
Overrides