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



2839
2840
2841
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 2839

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


2786
2787
2788
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 2786

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:



2792
2793
2794
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 2792

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) 


2797
2798
2799
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 2797

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) 


2804
2805
2806
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 2804

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:



2818
2819
2820
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 2818

def info_types
  @info_types
end

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

Corresponds to the JSON property limits

Returns:



2823
2824
2825
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 2823

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) 


2830
2831
2832
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 2830

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:



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

def rule_set
  @rule_set
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
 
# File 'generated/google/apis/dlp_v2/classes.rb', line 2844

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