Class Google::Cloud::Dlp::V2::InspectConfig (v0.8.1)

Version 0.8.1

• 1.5.0 (latest)
• 1.4.0
• 1.3.1
• 1.2.0
• 1.1.0
• 1.0.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.2
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.1
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.1

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

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#content_options

def content_options() -> ::Array<::Google::Cloud::Dlp::V2::ContentOption>

Returns

• (::Array<::Google::Cloud::Dlp::V2::ContentOption>) — List of options defining data content to scan. If empty, text, images, and other content will be included.

#content_options=

def content_options=(value) -> ::Array<::Google::Cloud::Dlp::V2::ContentOption>

Parameter

• value (::Array<::Google::Cloud::Dlp::V2::ContentOption>) — List of options defining data content to scan. If empty, text, images, and other content will be included.

Returns

• (::Array<::Google::Cloud::Dlp::V2::ContentOption>) — List of options defining data content to scan. If empty, text, images, and other content will be included.

#custom_info_types

def custom_info_types() -> ::Array<::Google::Cloud::Dlp::V2::CustomInfoType>

Returns

• (::Array<::Google::Cloud::Dlp::V2::CustomInfoType>) — CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

#custom_info_types=

def custom_info_types=(value) -> ::Array<::Google::Cloud::Dlp::V2::CustomInfoType>

Parameter

• value (::Array<::Google::Cloud::Dlp::V2::CustomInfoType>) — CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

Returns

• (::Array<::Google::Cloud::Dlp::V2::CustomInfoType>) — CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

#exclude_info_types

def exclude_info_types() -> ::Boolean

Returns

• (::Boolean) — When true, excludes type information of the findings.

#exclude_info_types=

def exclude_info_types=(value) -> ::Boolean

Parameter

• value (::Boolean) — When true, excludes type information of the findings.

Returns

• (::Boolean) — When true, excludes type information of the findings.

#include_quote

def include_quote() -> ::Boolean

Returns

• (::Boolean) — When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

#include_quote=

def include_quote=(value) -> ::Boolean

Parameter

• value (::Boolean) — When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

Returns

• (::Boolean) — When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

#info_types

def info_types() -> ::Array<::Google::Cloud::Dlp::V2::InfoType>

Returns

• (::Array<::Google::Cloud::Dlp::V2::InfoType>) — 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.

#info_types=

def info_types=(value) -> ::Array<::Google::Cloud::Dlp::V2::InfoType>

Parameter

• value (::Array<::Google::Cloud::Dlp::V2::InfoType>) — 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.

Returns

• (::Array<::Google::Cloud::Dlp::V2::InfoType>) — 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.

#limits

def limits() -> ::Google::Cloud::Dlp::V2::InspectConfig::FindingLimits

Returns

• (::Google::Cloud::Dlp::V2::InspectConfig::FindingLimits) — Configuration to control the number of findings returned.

#limits=

def limits=(value) -> ::Google::Cloud::Dlp::V2::InspectConfig::FindingLimits

Parameter

• value (::Google::Cloud::Dlp::V2::InspectConfig::FindingLimits) — Configuration to control the number of findings returned.

Returns

• (::Google::Cloud::Dlp::V2::InspectConfig::FindingLimits) — Configuration to control the number of findings returned.

#min_likelihood

def min_likelihood() -> ::Google::Cloud::Dlp::V2::Likelihood

Returns

• (::Google::Cloud::Dlp::V2::Likelihood) — Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

#min_likelihood=

def min_likelihood=(value) -> ::Google::Cloud::Dlp::V2::Likelihood

Parameter

• value (::Google::Cloud::Dlp::V2::Likelihood) — Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

Returns

• (::Google::Cloud::Dlp::V2::Likelihood) — Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

#rule_set

def rule_set() -> ::Array<::Google::Cloud::Dlp::V2::InspectionRuleSet>

Returns

• (::Array<::Google::Cloud::Dlp::V2::InspectionRuleSet>) — 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.

#rule_set=

def rule_set=(value) -> ::Array<::Google::Cloud::Dlp::V2::InspectionRuleSet>

Parameter

• value (::Array<::Google::Cloud::Dlp::V2::InspectionRuleSet>) — 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.

Returns

• (::Array<::Google::Cloud::Dlp::V2::InspectionRuleSet>) — 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.