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.



1512
1513
1514
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1512

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 CustomInfoType. Rules are applied in order that they are specified. Not supported for the surrogate_type CustomInfoType. Corresponds to the JSON property detectionRules

Returns:



1443
1444
1445
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1443

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

Returns:



1469
1470
1471
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1469

def dictionary
  @dictionary
end

#exclusion_type ⇒ String

If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Corresponds to the JSON property exclusionType

Returns:

  • (String) 


1475
1476
1477
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1475

def exclusion_type
  @exclusion_type
end

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

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

Returns:



1480
1481
1482
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1480

def info_type
  @info_type
end

#likelihood ⇒ String

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

Returns:

  • (String) 


1487
1488
1489
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1487

def likelihood
  @likelihood
end

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

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

Returns:



1492
1493
1494
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1492

def regex
  @regex
end

#stored_type ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2StoredType

A reference to a StoredInfoType to use with scanning. Corresponds to the JSON property storedType

Returns:



1497
1498
1499
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1497

def stored_type
  @stored_type
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 CustomInfoType does not support the use of detection_rules. Corresponds to the JSON property surrogateType

Returns:



1510
1511
1512
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1510

def surrogate_type
  @surrogate_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 1517

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