Google Cloud Data Loss Prevention v2 API - Class InspectConfig (4.8.0)

public sealed class InspectConfig : IMessage<InspectConfig>, IEquatable<InspectConfig>, IDeepCloneable<InspectConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Data Loss Prevention v2 API class InspectConfig.

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

Inheritance

object > InspectConfig

Implements

IMessage InspectConfig, IEquatable InspectConfig, IDeepCloneable InspectConfig, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dlp.V2

Assembly

Google.Cloud.Dlp.V2.dll

Constructors

InspectConfig()

public InspectConfig()

InspectConfig(InspectConfig)

public InspectConfig(InspectConfig other)

Parameter
Name	Description
`other`	`InspectConfig`

Properties

ContentOptions

public RepeatedField<ContentOption> ContentOptions { get; }

Deprecated and unused.

Property Value
Type	Description
`RepeatedFieldContentOption`

CustomInfoTypes

public RepeatedField<CustomInfoType> CustomInfoTypes { get; }

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

Property Value
Type	Description
`RepeatedFieldCustomInfoType`

ExcludeInfoTypes

public bool ExcludeInfoTypes { get; set; }

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

Property Value
Type	Description
`bool`

IncludeQuote

public bool IncludeQuote { get; set; }

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.

Property Value
Type	Description
`bool`

InfoTypes

public RepeatedField<InfoType> InfoTypes { get; }

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.

Property Value
Type	Description
`RepeatedFieldInfoType`

Limits

public InspectConfig.Types.FindingLimits Limits { get; set; }

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.

Property Value
Type	Description
`InspectConfigTypesFindingLimits`

MinLikelihood

public Likelihood MinLikelihood { get; set; }

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.

Property Value
Type	Description
`Likelihood`

MinLikelihoodPerInfoType

public RepeatedField<InspectConfig.Types.InfoTypeLikelihood> MinLikelihoodPerInfoType { get; }

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.

Property Value
Type	Description
`RepeatedFieldInspectConfigTypesInfoTypeLikelihood`

RuleSet

public RepeatedField<InspectionRuleSet> RuleSet { get; }

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.

Property Value
Type	Description
`RepeatedFieldInspectionRuleSet`