Class InspectConfig (3.9.1)

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

Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used.

Attributes

NameDescription
info_types Sequence[google.cloud.dlp_v2.types.InfoType]
Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.
min_likelihood google.cloud.dlp_v2.types.Likelihood
Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.
limits google.cloud.dlp_v2.types.InspectConfig.FindingLimits
Configuration to control the number of findings returned. This is not used for data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in `RedactImage][google.privacy.dlp.v2.DlpService.RedactImage]` requests. Otherwise, Cloud DLP returns an error.
include_quote bool
When true, a contextual quote from the data that triggered a finding is included in the response; see `Finding.quote][google.privacy.dlp.v2.Finding.quote]`. This is not used for data profiling.
exclude_info_types bool
When true, excludes type information of the findings. This is not used for data profiling.
custom_info_types Sequence[google.cloud.dlp_v2.types.CustomInfoType]
CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.
content_options Sequence[google.cloud.dlp_v2.types.ContentOption]
Deprecated and unused.
rule_set Sequence[google.cloud.dlp_v2.types.InspectionRuleSet]
Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.

Inheritance

builtins.object > proto.message.Message > InspectConfig

Classes

FindingLimits

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

Configuration to control the number of findings returned for inspection. This is not used for de-identification or data profiling.

When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage][google.privacy.dlp.v2.DlpService.RedactImage] requests. Otherwise, Cloud DLP returns an error.