Struct google_api_proto::google::privacy::dlp::v2::InspectConfig

pub struct InspectConfig {
    pub info_types: Vec<InfoType>,
    pub min_likelihood: i32,
    pub min_likelihood_per_info_type: Vec<InfoTypeLikelihood>,
    pub limits: Option<FindingLimits>,
    pub include_quote: bool,
    pub exclude_info_types: bool,
    pub custom_info_types: Vec<CustomInfoType>,
    pub content_options: Vec<i32>,
    pub rule_set: Vec<InspectionRuleSet>,
}

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

Fields

info_types: Vec<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.

min_likelihood: i32

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: Vec<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.

limits: Option<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][google.privacy.dlp.v2.DlpService.RedactImage] requests. Otherwise, Cloud DLP returns an error.

When set within an [InspectJobConfig][google.privacy.dlp.v2.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.

include_quote: bool

When true, a contextual quote from the data that triggered a finding is included in the response; see [Finding.quote][google.privacy.dlp.v2.Finding.quote]. This is not used for data profiling.

exclude_info_types: bool

When true, excludes type information of the findings. This is not used for data profiling.

custom_info_types: Vec<CustomInfoType>

CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more.

content_options: Vec<i32>

Deprecated and unused.

rule_set: Vec<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.

Implementations

impl InspectConfig

pub fn min_likelihood(&self) -> Likelihood

Returns the enum value of min_likelihood, or the default if the field is set to an invalid enum value.

pub fn set_min_likelihood(&mut self, value: Likelihood)

Sets min_likelihood to the provided enum value.

pub fn content_options( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<ContentOption>>

Returns an iterator which yields the valid enum values contained in content_options.

pub fn push_content_options(&mut self, value: ContentOption)

Appends the provided enum value to content_options.

Trait Implementations

impl Clone for InspectConfig

fn clone(&self) -> InspectConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InspectConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for InspectConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for InspectConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for InspectConfig

fn eq(&self, other: &InspectConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for InspectConfig