Class: Google::Apis::DlpV2::GooglePrivacyDlpV2ExclusionRule

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

Overview

The rule that specifies conditions when findings of infoTypes specified in InspectionRuleSet are removed from results.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GooglePrivacyDlpV2ExclusionRule

Returns a new instance of GooglePrivacyDlpV2ExclusionRule.



5073
5074
5075
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5073

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

Instance Attribute Details

#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:



5041
5042
5043
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5041

def dictionary
  @dictionary
end

#exclude_by_hotword ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2ExcludeByHotword

The rule to exclude findings based on a hotword. For record inspection of tables, column names are considered hotwords. An example of this is to exclude a finding if it belongs to a BigQuery column that matches a specific pattern. Corresponds to the JSON property excludeByHotword

Returns:



5048
5049
5050
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5048

def exclude_by_hotword
  @exclude_by_hotword
end

#exclude_by_image_findings ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2ExcludeByImageFindings

The rule to exclude image findings based on spatial relationships with other image findings. For example, exclude an image finding if it overlaps with another image finding. This rule is silently ignored if the content being inspected is not an image. Corresponds to the JSON property excludeByImageFindings

Returns:



5056
5057
5058
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5056

def exclude_by_image_findings
  @exclude_by_image_findings
end

#exclude_info_types ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2ExcludeInfoTypes

List of excluded infoTypes. Corresponds to the JSON property excludeInfoTypes

Returns:



5061
5062
5063
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5061

def exclude_info_types
  @exclude_info_types
end

#matching_type ⇒ String

How the rule is applied, see MatchingType documentation for details. Corresponds to the JSON property matchingType

Returns:

  • (String) 


5066
5067
5068
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5066

def matching_type
  @matching_type
end

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

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

Returns:



5071
5072
5073
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5071

def regex
  @regex
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5078
5079
5080
5081
5082
5083
5084
5085
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5078

def update!(**args)
  @dictionary = args[:dictionary] if args.key?(:dictionary)
  @exclude_by_hotword = args[:exclude_by_hotword] if args.key?(:exclude_by_hotword)
  @exclude_by_image_findings = args[:exclude_by_image_findings] if args.key?(:exclude_by_image_findings)
  @exclude_info_types = args[:exclude_info_types] if args.key?(:exclude_info_types)
  @matching_type = args[:matching_type] if args.key?(:matching_type)
  @regex = args[:regex] if args.key?(:regex)
end