Class CloudStorageOptions (3.1.1)

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

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

Attributes

NameDescription
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.
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.
file_types Sequence[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'.
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. .. attribute:: url

The Cloud Storage url of the file(s) to scan, in the format gs://<bucket>/<path>. Trailing wildcard in the path is allowed.

If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that gs://mybucket/ is equivalent to gs://mybucket/*, and gs://mybucket/directory/ is equivalent to gs://mybucket/directory/*.

Exactly one of url or regex_file_set must be set.

:type: str

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.