Interface InspectConfigOrBuilder (3.37.0)

Version 3.37.0

• 3.59.0 (latest)
• 3.58.0
• 3.57.0
• 3.56.0
• 3.55.0
• 3.53.0
• 3.52.0
• 3.51.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.6
• 3.6.7
• 3.5.0
• 3.4.0
• 3.3.2
• 3.2.1
• 3.1.4

public interface InspectConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getContentOptions(int index)

public abstract ContentOption getContentOptions(int index)

Deprecated and unused.

repeated .google.privacy.dlp.v2.ContentOption content_options = 8;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
ContentOption	The contentOptions at the given index.

getContentOptionsCount()

public abstract int getContentOptionsCount()

Deprecated and unused.

repeated .google.privacy.dlp.v2.ContentOption content_options = 8;

Returns
Type	Description
int	The count of contentOptions.

getContentOptionsList()

public abstract List<ContentOption> getContentOptionsList()

Deprecated and unused.

repeated .google.privacy.dlp.v2.ContentOption content_options = 8;

Returns
Type	Description
List<ContentOption>	A list containing the contentOptions.

getContentOptionsValue(int index)

public abstract int getContentOptionsValue(int index)

Deprecated and unused.

repeated .google.privacy.dlp.v2.ContentOption content_options = 8;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
int	The enum numeric value on the wire of contentOptions at the given index.

getContentOptionsValueList()

public abstract List<Integer> getContentOptionsValueList()

Deprecated and unused.

repeated .google.privacy.dlp.v2.ContentOption content_options = 8;

Returns
Type	Description
List<Integer>	A list containing the enum numeric values on the wire for contentOptions.

getCustomInfoTypes(int index)

public abstract CustomInfoType getCustomInfoTypes(int index)

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

repeated .google.privacy.dlp.v2.CustomInfoType custom_info_types = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
CustomInfoType

getCustomInfoTypesCount()

public abstract int getCustomInfoTypesCount()

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

repeated .google.privacy.dlp.v2.CustomInfoType custom_info_types = 6;

Returns
Type	Description
int

getCustomInfoTypesList()

public abstract List<CustomInfoType> getCustomInfoTypesList()

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

repeated .google.privacy.dlp.v2.CustomInfoType custom_info_types = 6;

Returns
Type	Description
List<CustomInfoType>

getCustomInfoTypesOrBuilder(int index)

public abstract CustomInfoTypeOrBuilder getCustomInfoTypesOrBuilder(int index)

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

repeated .google.privacy.dlp.v2.CustomInfoType custom_info_types = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
CustomInfoTypeOrBuilder

getCustomInfoTypesOrBuilderList()

public abstract List<? extends CustomInfoTypeOrBuilder> getCustomInfoTypesOrBuilderList()

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

repeated .google.privacy.dlp.v2.CustomInfoType custom_info_types = 6;

Returns
Type	Description
List<? extends com.google.privacy.dlp.v2.CustomInfoTypeOrBuilder>

getExcludeInfoTypes()

public abstract boolean getExcludeInfoTypes()

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

bool exclude_info_types = 5;

Returns
Type	Description
boolean	The excludeInfoTypes.

getIncludeQuote()

public abstract boolean getIncludeQuote()

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.

bool include_quote = 4;

Returns
Type	Description
boolean	The includeQuote.

getInfoTypes(int index)

public abstract InfoType getInfoTypes(int index)

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

repeated .google.privacy.dlp.v2.InfoType info_types = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
InfoType

getInfoTypesCount()

public abstract int getInfoTypesCount()

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

repeated .google.privacy.dlp.v2.InfoType info_types = 1;

Returns
Type	Description
int

getInfoTypesList()

public abstract List<InfoType> getInfoTypesList()

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

repeated .google.privacy.dlp.v2.InfoType info_types = 1;

Returns
Type	Description
List<InfoType>

getInfoTypesOrBuilder(int index)

public abstract InfoTypeOrBuilder getInfoTypesOrBuilder(int index)

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

repeated .google.privacy.dlp.v2.InfoType info_types = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
InfoTypeOrBuilder

getInfoTypesOrBuilderList()

public abstract List<? extends InfoTypeOrBuilder> getInfoTypesOrBuilderList()

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

repeated .google.privacy.dlp.v2.InfoType info_types = 1;

Returns
Type	Description
List<? extends com.google.privacy.dlp.v2.InfoTypeOrBuilder>

getLimits()

public abstract InspectConfig.FindingLimits getLimits()

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.

.google.privacy.dlp.v2.InspectConfig.FindingLimits limits = 3;

Returns
Type	Description
InspectConfig.FindingLimits	The limits.

getLimitsOrBuilder()

public abstract InspectConfig.FindingLimitsOrBuilder getLimitsOrBuilder()

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.

.google.privacy.dlp.v2.InspectConfig.FindingLimits limits = 3;

Returns
Type	Description
InspectConfig.FindingLimitsOrBuilder

getMinLikelihood()

public abstract Likelihood getMinLikelihood()

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.

.google.privacy.dlp.v2.Likelihood min_likelihood = 2;

Returns
Type	Description
Likelihood	The minLikelihood.

getMinLikelihoodPerInfoType(int index)

public abstract InspectConfig.InfoTypeLikelihood getMinLikelihoodPerInfoType(int index)

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.

repeated .google.privacy.dlp.v2.InspectConfig.InfoTypeLikelihood min_likelihood_per_info_type = 11;

Parameter
Name	Description
index	int

Returns
Type	Description
InspectConfig.InfoTypeLikelihood

getMinLikelihoodPerInfoTypeCount()

public abstract int getMinLikelihoodPerInfoTypeCount()

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.

repeated .google.privacy.dlp.v2.InspectConfig.InfoTypeLikelihood min_likelihood_per_info_type = 11;

Returns
Type	Description
int

getMinLikelihoodPerInfoTypeList()

public abstract List<InspectConfig.InfoTypeLikelihood> getMinLikelihoodPerInfoTypeList()

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.

repeated .google.privacy.dlp.v2.InspectConfig.InfoTypeLikelihood min_likelihood_per_info_type = 11;

Returns
Type	Description
List<InfoTypeLikelihood>

getMinLikelihoodPerInfoTypeOrBuilder(int index)

public abstract InspectConfig.InfoTypeLikelihoodOrBuilder getMinLikelihoodPerInfoTypeOrBuilder(int index)

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.

repeated .google.privacy.dlp.v2.InspectConfig.InfoTypeLikelihood min_likelihood_per_info_type = 11;

Parameter
Name	Description
index	int

Returns
Type	Description
InspectConfig.InfoTypeLikelihoodOrBuilder

getMinLikelihoodPerInfoTypeOrBuilderList()

public abstract List<? extends InspectConfig.InfoTypeLikelihoodOrBuilder> getMinLikelihoodPerInfoTypeOrBuilderList()

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.

repeated .google.privacy.dlp.v2.InspectConfig.InfoTypeLikelihood min_likelihood_per_info_type = 11;

Returns
Type	Description
List<? extends com.google.privacy.dlp.v2.InspectConfig.InfoTypeLikelihoodOrBuilder>

getMinLikelihoodValue()

public abstract int getMinLikelihoodValue()

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.

.google.privacy.dlp.v2.Likelihood min_likelihood = 2;

Returns
Type	Description
int	The enum numeric value on the wire for minLikelihood.

getRuleSet(int index)

public abstract InspectionRuleSet getRuleSet(int index)

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.

repeated .google.privacy.dlp.v2.InspectionRuleSet rule_set = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
InspectionRuleSet

getRuleSetCount()

public abstract int getRuleSetCount()

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.

repeated .google.privacy.dlp.v2.InspectionRuleSet rule_set = 10;

Returns
Type	Description
int

getRuleSetList()

public abstract List<InspectionRuleSet> getRuleSetList()

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.

repeated .google.privacy.dlp.v2.InspectionRuleSet rule_set = 10;

Returns
Type	Description
List<InspectionRuleSet>

getRuleSetOrBuilder(int index)

public abstract InspectionRuleSetOrBuilder getRuleSetOrBuilder(int index)

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.

repeated .google.privacy.dlp.v2.InspectionRuleSet rule_set = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
InspectionRuleSetOrBuilder

getRuleSetOrBuilderList()

public abstract List<? extends InspectionRuleSetOrBuilder> getRuleSetOrBuilderList()

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.

repeated .google.privacy.dlp.v2.InspectionRuleSet rule_set = 10;

Returns
Type	Description
List<? extends com.google.privacy.dlp.v2.InspectionRuleSetOrBuilder>

hasLimits()

public abstract boolean hasLimits()

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.

.google.privacy.dlp.v2.InspectConfig.FindingLimits limits = 3;

Returns
Type	Description
boolean	Whether the limits field is set.