Class: Google::Apis::DlpV2::GooglePrivacyDlpV2InspectConfig

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

Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GooglePrivacyDlpV2InspectConfig

Returns a new instance of GooglePrivacyDlpV2InspectConfig.



3164
3165
3166
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 3164

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

Instance Attribute Details

#content_options ⇒ Array<String>

List of options defining data content to scan. If empty, text, images, and other content will be included. Corresponds to the JSON property contentOptions

Returns:

  • (Array<String>) 


3112
3113
3114
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 3112

def content_options
  @content_options
end

#custom_info_types ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2CustomInfoType>

CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/ creating-custom-infotypes to learn more. Corresponds to the JSON property customInfoTypes

Returns:



3118
3119
3120
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 3118

def custom_info_types
  @custom_info_types
end

#exclude_info_types ⇒ Boolean Also known as: exclude_info_types?

When true, excludes type information of the findings. Corresponds to the JSON property excludeInfoTypes

Returns:

  • (Boolean) 


3123
3124
3125
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 3123

def exclude_info_types
  @exclude_info_types
end

#include_quote ⇒ Boolean Also known as: include_quote?

When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote. Corresponds to the JSON property includeQuote

Returns:

  • (Boolean) 


3130
3131
3132
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 3130

def include_quote
  @include_quote
end

#info_types ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2InfoType>

Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/ docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time. Corresponds to the JSON property infoTypes

Returns:



3143
3144
3145
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 3143

def info_types
  @info_types
end

#limits ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2FindingLimits

Configuration to control the number of findings returned. Cannot be set if de- identification is requested. Corresponds to the JSON property limits

Returns:



3149
3150
3151
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 3149

def limits
  @limits
end

#min_likelihood ⇒ String

Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more. Corresponds to the JSON property minLikelihood

Returns:

  • (String) 


3155
3156
3157
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 3155

def min_likelihood
  @min_likelihood
end

#rule_set ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2InspectionRuleSet>

Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Corresponds to the JSON property ruleSet

Returns:



3162
3163
3164
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 3162

def rule_set
  @rule_set
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 3169

def update!(**args)
  @content_options = args[:content_options] if args.key?(:content_options)
  @custom_info_types = args[:custom_info_types] if args.key?(:custom_info_types)
  @exclude_info_types = args[:exclude_info_types] if args.key?(:exclude_info_types)
  @include_quote = args[:include_quote] if args.key?(:include_quote)
  @info_types = args[:info_types] if args.key?(:info_types)
  @limits = args[:limits] if args.key?(:limits)
  @min_likelihood = args[:min_likelihood] if args.key?(:min_likelihood)
  @rule_set = args[:rule_set] if args.key?(:rule_set)
end