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.



2856
2857
2858
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2856

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:



2773
2774
2775
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2773

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:



2796
2797
2798
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2796

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) 


2803
2804
2805
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2803

def exclusion_type
  @exclusion_type
end

#file_label_info_type ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2FileLabelInfoType

Configuration for a custom infoType that detects file labels. Corresponds to the JSON property fileLabelInfoType

Returns:



2808
2809
2810
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2808

def file_label_info_type
  @file_label_info_type
end

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

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

Returns:



2813
2814
2815
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2813

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) 


2820
2821
2822
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2820

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:



2826
2827
2828
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2826

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:



2831
2832
2833
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2831

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:



2837
2838
2839
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2837

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:



2842
2843
2844
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2842

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:



2854
2855
2856
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2854

def surrogate_type
  @surrogate_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 2861

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)
  @file_label_info_type = args[:file_label_info_type] if args.key?(:file_label_info_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