Data Loss Prevention V2 Client - Class CloudStorageOptions (1.9.0)

Reference documentation and code samples for the Data Loss Prevention V2 Client class CloudStorageOptions.

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

Generated from protobuf message google.privacy.dlp.v2.CloudStorageOptions

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ file_set Google\Cloud\Dlp\V2\CloudStorageOptions\FileSet

The set of one or more files to scan.

↳ bytes_limit_per_file int|string

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.

↳ bytes_limit_per_file_percent int

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.

↳ file_types array

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

↳ sample_method int
↳ files_limit_percent int

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.

getFileSet

The set of one or more files to scan.

Returns
TypeDescription
Google\Cloud\Dlp\V2\CloudStorageOptions\FileSet|null

hasFileSet

clearFileSet

setFileSet

The set of one or more files to scan.

Parameter
NameDescription
var Google\Cloud\Dlp\V2\CloudStorageOptions\FileSet
Returns
TypeDescription
$this

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.

Returns
TypeDescription
int|string

setBytesLimitPerFile

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.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

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.

Returns
TypeDescription
int

setBytesLimitPerFilePercent

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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getFileTypes

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setFileTypes

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

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this

getSampleMethod

Generated from protobuf field .google.privacy.dlp.v2.CloudStorageOptions.SampleMethod sample_method = 6;

Returns
TypeDescription
int

setSampleMethod

Generated from protobuf field .google.privacy.dlp.v2.CloudStorageOptions.SampleMethod sample_method = 6;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

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.

Returns
TypeDescription
int

setFilesLimitPercent

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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this