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

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

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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GooglePrivacyDlpV2InspectConfig

Returns a new instance of GooglePrivacyDlpV2InspectConfig.



3275
3276
3277
# File 'generated/google/apis/dlp_v2/classes.rb', line 3275

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

Instance Attribute Details

#content_optionsArray<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>)


3222
3223
3224
# File 'generated/google/apis/dlp_v2/classes.rb', line 3222

def content_options
  @content_options
end

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



3228
3229
3230
# File 'generated/google/apis/dlp_v2/classes.rb', line 3228

def custom_info_types
  @custom_info_types
end

#exclude_info_typesBoolean Also known as: exclude_info_types?

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

Returns:

  • (Boolean)


3233
3234
3235
# File 'generated/google/apis/dlp_v2/classes.rb', line 3233

def exclude_info_types
  @exclude_info_types
end

#include_quoteBoolean 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)


3240
3241
3242
# File 'generated/google/apis/dlp_v2/classes.rb', line 3240

def include_quote
  @include_quote
end

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



3254
3255
3256
# File 'generated/google/apis/dlp_v2/classes.rb', line 3254

def info_types
  @info_types
end

#limitsGoogle::Apis::DlpV2::GooglePrivacyDlpV2FindingLimits

Configuration to control the number of findings returned. Corresponds to the JSON property limits



3259
3260
3261
# File 'generated/google/apis/dlp_v2/classes.rb', line 3259

def limits
  @limits
end

#min_likelihoodString

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)


3266
3267
3268
# File 'generated/google/apis/dlp_v2/classes.rb', line 3266

def min_likelihood
  @min_likelihood
end

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



3273
3274
3275
# File 'generated/google/apis/dlp_v2/classes.rb', line 3273

def rule_set
  @rule_set
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
# File 'generated/google/apis/dlp_v2/classes.rb', line 3280

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