Class: Google::Apis::DlpV2::GooglePrivacyDlpV2CustomInfoType

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

Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.

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) ⇒ GooglePrivacyDlpV2CustomInfoType

Returns a new instance of GooglePrivacyDlpV2CustomInfoType



1142
1143
1144
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1142

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

Instance Attribute Details

#detection_rules ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2DetectionRule>

Set of detection rules to apply to all findings of this custom info type. Rules are applied in order that they are specified. Not supported for the surrogate_type custom info type. Corresponds to the JSON property detectionRules

Returns:



1088
1089
1090
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1088

def detection_rules
  @detection_rules
end

#dictionary ⇒ Google::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. Corresponds to the JSON property dictionary

Returns:



1110
1111
1112
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1110

def dictionary
  @dictionary
end

#info_type ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2InfoType

Type of information detected by the API. Corresponds to the JSON property infoType

Returns:



1115
1116
1117
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1115

def info_type
  @info_type
end

#likelihood ⇒ String

Likelihood to return for this custom info type. 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. Corresponds to the JSON property likelihood

Returns:

  • (String) 


1122
1123
1124
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1122

def likelihood
  @likelihood
end

#regex ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2Regex

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

Returns:



1127
1128
1129
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1127

def regex
  @regex
end

#surrogate_type ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2SurrogateType

Message for detecting output from deidentification transformations such as 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 custom info type does not support the use of detection_rules. Corresponds to the JSON property surrogateType

Returns:



1140
1141
1142
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1140

def surrogate_type
  @surrogate_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1147
1148
1149
1150
1151
1152
1153
1154
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1147

def update!(**args)
  @detection_rules = args[:detection_rules] if args.key?(:detection_rules)
  @dictionary = args[:dictionary] if args.key?(:dictionary)
  @info_type = args[:info_type] if args.key?(:info_type)
  @likelihood = args[:likelihood] if args.key?(:likelihood)
  @regex = args[:regex] if args.key?(:regex)
  @surrogate_type = args[:surrogate_type] if args.key?(:surrogate_type)
end