CustomInfoType
(
mapping
=
None
,
*
,
ignore_unknown_fields
=
False
,
**
kwargs
)
Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.
Attributes
info_type
.storage.InfoType
CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in
InspectContent.info_types
field. Specifying the latter
adds findings to the one detected by the system. If built-in
info type is not specified in InspectContent.info_types
list then the name is treated as a custom info type.likelihood
.storage.Likelihood
Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to
VERY_LIKELY
if not specified.dictionary
.storage.CustomInfoType.Dictionary
A list of phrases to detect as a CustomInfoType.
regex
.storage.CustomInfoType.Regex
Regular expression based CustomInfoType.
surrogate_type
.storage.CustomInfoType.SurrogateType
Message for detecting output from deidentification transformations that support reversing.
stored_type
.storage.StoredType
Load an existing
StoredInfoType
resource for use in InspectDataSource
. Not currently supported in InspectContent
.detection_rules
Sequence[ .storage.CustomInfoType.DetectionRule
]
Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the
surrogate_type
CustomInfoType.exclusion_type
.storage.CustomInfoType.ExclusionType
If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.
Classes
DetectionRule
DetectionRule
(
mapping
=
None
,
*
,
ignore_unknown_fields
=
False
,
**
kwargs
)
Deprecated; use InspectionRuleSet
instead. Rule for modifying a CustomInfoType
to alter behavior under certain circumstances,
depending on the specific details of the rule. Not supported for the surrogate_type
custom infoType.
Dictionary
Dictionary
(
mapping
=
None
,
*
,
ignore_unknown_fields
=
False
,
**
kwargs
)
Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles.
Dictionary words are case-insensitive and all characters other than
letters and digits in the unicode Basic Multilingual
Plane <https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane>
__
will be replaced with whitespace when scanning for matches, so the
dictionary phrase "Sam Johnson" will match all three phrases "sam
johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the
characters surrounding any match must be of a different type than
the adjacent characters within the word, so letters must be next to
non-letters and digits next to non-digits. For example, the
dictionary word "jen" will match the first three letters of the text
"jen123" but will return no matches for "jennifer".
Dictionary words containing a large number of characters that are
not letters or digits may result in unexpected findings because such
characters are treated as whitespace. The limits <https://cloud.google.com/dlp/limits>
__ page contains
details about the size limits of dictionaries. For dictionaries that
do not fit within these constraints, consider using LargeCustomDictionaryConfig
in the StoredInfoType
API.
Regex
Regex
(
mapping
=
None
,
*
,
ignore_unknown_fields
=
False
,
**
kwargs
)
Message defining a custom regular expression.
SurrogateType
SurrogateType
(
mapping
=
None
,
*
,
ignore_unknown_fields
=
False
,
**
kwargs
)
Message for detecting output from deidentification transformations
such as `CryptoReplaceFfxFpeConfig
https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig
__.
These types of transformations are those that perform
pseudonymization, thereby producing a "surrogate" as output. This
should be used in conjunction with a field on the transformation
such as
surrogate_info_type . This CustomInfoType does not
support the use of
detection_rules`.
