Class CloudStorageOptions (3.16.0)

CloudStorageOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Attributes

Name Description
file_set google.cloud.dlp_v2.types.CloudStorageOptions.FileSet
The set of one or more files to scan.
bytes_limit_per_file int
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
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. 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
file_types MutableSequence[google.cloud.dlp_v2.types.FileType]
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 google.cloud.dlp_v2.types.CloudStorageOptions.SampleMethod
How to sample the data.
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.

Classes

FileSet

FileSet(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Set of files to scan.

SampleMethod

SampleMethod(value)

How to sample bytes if not all bytes are scanned. Meaningful only when used in conjunction with bytes_limit_per_file. If not specified, scanning would start from the top.

Values: SAMPLE_METHOD_UNSPECIFIED (0): No sampling. TOP (1): Scan from the top (default). RANDOM_START (2): For each file larger than bytes_limit_per_file, randomly pick the offset to start scanning. The scanned bytes are contiguous.