Class Dictionary (3.24.0)

Version 3.24.0

• 3.26.0 (latest)
• 3.25.1
• 3.24.0
• 3.23.0
• 3.22.0
• 3.20.0
• 3.19.0
• 3.18.1
• 3.17.0
• 3.16.0
• 3.15.3
• 3.14.0
• 3.13.0
• 3.12.3
• 3.11.1
• 3.10.1
• 3.9.2
• 3.8.1
• 3.7.1
• 3.6.2
• 3.5.0
• 3.4.0
• 3.3.1
• 3.2.4
• 3.1.1
• 3.0.1
• 2.0.2
• 1.0.2
• 0.15.2
• 0.14.0
• 0.13.0
• 0.12.1

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/sensitive-data-protection/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

Attributes
Name	Description
word_list	google.cloud.dlp_v2.types.CustomInfoType.Dictionary.WordList List of words or phrases to search for. This field is a member of oneof_ source.
cloud_storage_path	google.cloud.dlp_v2.types.CloudStoragePath Newline-delimited file of words in Cloud Storage. Only a single file is accepted. This field is a member of oneof_ source.

Classes

WordList

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

Message defining a list of words or phrases to search for in the data.