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

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

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

Constructor Details

#initialize(**args) ⇒ GooglePrivacyDlpV2CustomInfoType

Returns a new instance of GooglePrivacyDlpV2CustomInfoType.



2560
2561
2562
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2560

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 the order that they are specified. Only supported for the dictionary, regex, and stored_type CustomInfoTypes. Corresponds to the JSON property detectionRules

Returns:



2483
2484
2485
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2483

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:



2505
2506
2507
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2505

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. Only supported for the dictionary, regex, and stored_type CustomInfoTypes. Corresponds to the JSON property exclusionType

Returns:

  • (String) 


2512
2513
2514
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2512

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:



2517
2518
2519
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2517

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) 


2524
2525
2526
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2524

def likelihood
  @likelihood
end

#metadata_key_value_expression ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2MetadataKeyValueExpression

Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. Corresponds to the JSON property metadataKeyValueExpression

Returns:



2530
2531
2532
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2530

def metadata_key_value_expression
  @metadata_key_value_expression
end

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

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

Returns:



2535
2536
2537
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2535

def regex
  @regex
end

#sensitivity_score ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2SensitivityScore

Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. Corresponds to the JSON property sensitivityScore

Returns:



2541
2542
2543
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2541

def sensitivity_score
  @sensitivity_score
end

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

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

Returns:



2546
2547
2548
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2546

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:



2558
2559
2560
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2558

def surrogate_type
  @surrogate_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2565

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)
  @metadata_key_value_expression = args[:metadata_key_value_expression] if args.key?(:metadata_key_value_expression)
  @regex = args[:regex] if args.key?(:regex)
  @sensitivity_score = args[:sensitivity_score] if args.key?(:sensitivity_score)
  @stored_type = args[:stored_type] if args.key?(:stored_type)
  @surrogate_type = args[:surrogate_type] if args.key?(:surrogate_type)
end