Class: Google::Cloud::Dlp::V2::CustomInfoType::Dictionary

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/privacy/dlp/v2/storage.rb

Overview

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 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 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.

Defined Under Namespace

Classes: WordList

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_storage_path ⇒ ::Google::Cloud::Dlp::V2::CloudStoragePath

Returns Newline-delimited file of words in Cloud Storage. Only a single file is accepted.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/privacy/dlp/v2/storage.rb', line 170

class Dictionary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message defining a list of words or phrases to search for in the data.
  # @!attribute [rw] words
  #   @return [::Array<::String>]
  #     Words or phrases defining the dictionary. The dictionary must contain
  #     at least one phrase and every phrase must contain at least 2 characters
  #     that are letters or digits. [required]
  class WordList
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#word_list ⇒ ::Google::Cloud::Dlp::V2::CustomInfoType::Dictionary::WordList

Returns List of words or phrases to search for.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/privacy/dlp/v2/storage.rb', line 170

class Dictionary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message defining a list of words or phrases to search for in the data.
  # @!attribute [rw] words
  #   @return [::Array<::String>]
  #     Words or phrases defining the dictionary. The dictionary must contain
  #     at least one phrase and every phrase must contain at least 2 characters
  #     that are letters or digits. [required]
  class WordList
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end