Class: Google::Apis::DlpV2::GooglePrivacyDlpV2InspectConfig
- Inherits:
-
Object
- Object
- Google::Apis::DlpV2::GooglePrivacyDlpV2InspectConfig
- 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
-
#content_options ⇒ Array<String>
List of options defining data content to scan.
-
#custom_info_types ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2CustomInfoType>
CustomInfoTypes provided by the user.
-
#exclude_info_types ⇒ Boolean
(also: #exclude_info_types?)
When true, excludes type information of the findings.
-
#include_quote ⇒ Boolean
(also: #include_quote?)
When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.
-
#info_types ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2InfoType>
Restricts what info_types to look for.
-
#limits ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2FindingLimits
Configuration to control the number of findings returned.
-
#min_likelihood ⇒ String
Only returns findings equal or above this threshold.
-
#rule_set ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2InspectionRuleSet>
Set of rules to apply to the findings for this InspectConfig.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GooglePrivacyDlpV2InspectConfig
constructor
A new instance of GooglePrivacyDlpV2InspectConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GooglePrivacyDlpV2InspectConfig
Returns a new instance of GooglePrivacyDlpV2InspectConfig.
2906 2907 2908 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 2906 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
2853 2854 2855 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 2853 def @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
2859 2860 2861 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 2859 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
2864 2865 2866 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 2864 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
2871 2872 2873 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 2871 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
2885 2886 2887 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 2885 def info_types @info_types end |
#limits ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2FindingLimits
Configuration to control the number of findings returned.
Corresponds to the JSON property limits
2890 2891 2892 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 2890 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
2897 2898 2899 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 2897 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
2904 2905 2906 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 2904 def rule_set @rule_set end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 2911 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 |