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.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes | |
---|---|
Name | Description |
info_type |
google.cloud.dlp_v2.types.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 |
google.cloud.dlp_v2.types.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 |
google.cloud.dlp_v2.types.CustomInfoType.Dictionary
A list of phrases to detect as a CustomInfoType. This field is a member of oneof _ type .
|
regex |
google.cloud.dlp_v2.types.CustomInfoType.Regex
Regular expression based CustomInfoType. This field is a member of oneof _ type .
|
surrogate_type |
google.cloud.dlp_v2.types.CustomInfoType.SurrogateType
Message for detecting output from deidentification transformations that support reversing. This field is a member of oneof _ type .
|
stored_type |
google.cloud.dlp_v2.types.StoredType
Load an existing StoredInfoType resource for use in
InspectDataSource . Not currently supported in
InspectContent .
This field is a member of oneof _ type .
|
detection_rules |
MutableSequence[google.cloud.dlp_v2.types.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 |
google.cloud.dlp_v2.types.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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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`.