Class: Google::Apis::DlpV2::GooglePrivacyDlpV2StoredInfoTypeConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dlp_v2/classes.rb,
generated/google/apis/dlp_v2/representations.rb,
generated/google/apis/dlp_v2/representations.rb

Overview

Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GooglePrivacyDlpV2StoredInfoTypeConfig

Returns a new instance of GooglePrivacyDlpV2StoredInfoTypeConfig.



5836
5837
5838
# File 'generated/google/apis/dlp_v2/classes.rb', line 5836

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#descriptionString

Description of the StoredInfoType (max 256 characters). Corresponds to the JSON property description

Returns:

  • (String)


5788
5789
5790
# File 'generated/google/apis/dlp_v2/classes.rb', line 5788

def description
  @description
end

#dictionaryGoogle::Apis::DlpV2::GooglePrivacyDlpV2Dictionary

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. Corresponds to the JSON property dictionary



5814
5815
5816
# File 'generated/google/apis/dlp_v2/classes.rb', line 5814

def dictionary
  @dictionary
end

#display_nameString

Display name of the StoredInfoType (max 256 characters). Corresponds to the JSON property displayName

Returns:

  • (String)


5819
5820
5821
# File 'generated/google/apis/dlp_v2/classes.rb', line 5819

def display_name
  @display_name
end

#large_custom_dictionaryGoogle::Apis::DlpV2::GooglePrivacyDlpV2LargeCustomDictionaryConfig

Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the limits page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using CustomInfoType.Dictionary for smaller dictionaries that satisfy the size requirements. Corresponds to the JSON property largeCustomDictionary



5829
5830
5831
# File 'generated/google/apis/dlp_v2/classes.rb', line 5829

def large_custom_dictionary
  @large_custom_dictionary
end

#regexGoogle::Apis::DlpV2::GooglePrivacyDlpV2Regex

Message defining a custom regular expression. Corresponds to the JSON property regex



5834
5835
5836
# File 'generated/google/apis/dlp_v2/classes.rb', line 5834

def regex
  @regex
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5841
5842
5843
5844
5845
5846
5847
# File 'generated/google/apis/dlp_v2/classes.rb', line 5841

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @dictionary = args[:dictionary] if args.key?(:dictionary)
  @display_name = args[:display_name] if args.key?(:display_name)
  @large_custom_dictionary = args[:large_custom_dictionary] if args.key?(:large_custom_dictionary)
  @regex = args[:regex] if args.key?(:regex)
end