Cloud Data Loss Prevention (DLP) V2 API - Class Google::Cloud::Dlp::V2::InspectConfig (v1.4.0)

Reference documentation and code samples for the Cloud Data Loss Prevention (DLP) V2 API class Google::Cloud::Dlp::V2::InspectConfig.

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>) — Deprecated and unused.

#content_options=

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

Parameter

value (::Array<::Google::Cloud::Dlp::V2::ContentOption>) — Deprecated and unused.

Returns

(::Array<::Google::Cloud::Dlp::V2::ContentOption>) — Deprecated and unused.

#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/sensitive-data-protection/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/sensitive-data-protection/docs/creating-custom-infotypes to learn more.

Returns

(::Array<::Google::Cloud::Dlp::V2::CustomInfoType>) — CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/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. This is not used for data profiling.

#exclude_info_types=

def exclude_info_types=(value) -> ::Boolean

Parameter

value (::Boolean) — When true, excludes type information of the findings. This is not used for data profiling.

Returns

(::Boolean) — When true, excludes type information of the findings. This is not used for data profiling.

#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. This is not used for data profiling.

#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. This is not used for data profiling.

Returns

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

#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/sensitive-data-protection/docs/infotypes-reference.

When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time.

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/sensitive-data-protection/docs/infotypes-reference.

When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time.

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/sensitive-data-protection/docs/infotypes-reference.

When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time.

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. This is not used for data profiling.

When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error.

When set within an InspectJobConfig, the specified maximum values aren't hard limits. If an inspection job reaches these limits, the job ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than these maximum values.

#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. This is not used for data profiling.

When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error.

When set within an InspectJobConfig, the specified maximum values aren't hard limits. If an inspection job reaches these limits, the job ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than these maximum values.

Returns

(::Google::Cloud::Dlp::V2::InspectConfig::FindingLimits) — Configuration to control the number of findings returned. This is not used for data profiling.

When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error.

When set within an InspectJobConfig, the specified maximum values aren't hard limits. If an inspection job reaches these limits, the job ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than these maximum values.

#min_likelihood

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

Returns

(::Google::Cloud::Dlp::V2::Likelihood) — Only returns findings equal to or above this threshold. The default is POSSIBLE.

In general, the highest likelihood setting yields the fewest findings in results and the lowest chance of a false positive. For more information, see Match likelihood.

#min_likelihood=

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

Parameter

value (::Google::Cloud::Dlp::V2::Likelihood) — Only returns findings equal to or above this threshold. The default is POSSIBLE.

In general, the highest likelihood setting yields the fewest findings in results and the lowest chance of a false positive. For more information, see Match likelihood.

Returns

(::Google::Cloud::Dlp::V2::Likelihood) — Only returns findings equal to or above this threshold. The default is POSSIBLE.

In general, the highest likelihood setting yields the fewest findings in results and the lowest chance of a false positive. For more information, see Match likelihood.

#min_likelihood_per_info_type

def min_likelihood_per_info_type() -> ::Array<::Google::Cloud::Dlp::V2::InspectConfig::InfoTypeLikelihood>

Returns

(::Array<::Google::Cloud::Dlp::V2::InspectConfig::InfoTypeLikelihood>) — Minimum likelihood per infotype. For each infotype, a user can specify a minimum likelihood. The system only returns a finding if its likelihood is above this threshold. If this field is not set, the system uses the InspectConfig min_likelihood.

#min_likelihood_per_info_type=

def min_likelihood_per_info_type=(value) -> ::Array<::Google::Cloud::Dlp::V2::InspectConfig::InfoTypeLikelihood>

Parameter

value (::Array<::Google::Cloud::Dlp::V2::InspectConfig::InfoTypeLikelihood>) — Minimum likelihood per infotype. For each infotype, a user can specify a minimum likelihood. The system only returns a finding if its likelihood is above this threshold. If this field is not set, the system uses the InspectConfig min_likelihood.

Returns

(::Array<::Google::Cloud::Dlp::V2::InspectConfig::InfoTypeLikelihood>) — Minimum likelihood per infotype. For each infotype, a user can specify a minimum likelihood. The system only returns a finding if its likelihood is above this threshold. If this field is not set, the system uses the InspectConfig min_likelihood.

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