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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
Google\Cloud\Dlp\V2\CloudStorageOptions\FileSet|null | |
hasFileSet
clearFileSet
setFileSet
The set of one or more files to scan.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dlp\V2\CloudStorageOptions\FileSet
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSampleMethod
Generated from protobuf field .google.privacy.dlp.v2.CloudStorageOptions.SampleMethod sample_method = 6;
| Returns | |
|---|---|
| Type | Description |
int | |
setSampleMethod
Generated from protobuf field .google.privacy.dlp.v2.CloudStorageOptions.SampleMethod sample_method = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |