Class InspectConfig.Builder (3.57.0) 

public static final class InspectConfig.Builder extends GeneratedMessageV3.Builder<InspectConfig.Builder> implements InspectConfigOrBuilder

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

Protobuf type google.privacy.dlp.v2.InspectConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > InspectConfig.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllContentOptions(Iterable<? extends ContentOption> values)

public InspectConfig.Builder addAllContentOptions(Iterable<? extends ContentOption> values)

Deprecated and unused.

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

Parameter
Name Description
values Iterable<? extends com.google.privacy.dlp.v2.ContentOption>

The contentOptions to add.
Returns
Type Description
InspectConfig.Builder

This builder for chaining.

addAllContentOptionsValue(Iterable<Integer> values)

public InspectConfig.Builder addAllContentOptionsValue(Iterable<Integer> values)

Deprecated and unused.

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

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for contentOptions to add.
Returns
Type Description
InspectConfig.Builder

This builder for chaining.

addAllCustomInfoTypes(Iterable<? extends CustomInfoType> values)

public InspectConfig.Builder addAllCustomInfoTypes(Iterable<? extends CustomInfoType> values)

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

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

Parameter
Name Description
values Iterable<? extends com.google.privacy.dlp.v2.CustomInfoType>
Returns
Type Description
InspectConfig.Builder

addAllInfoTypes(Iterable<? extends InfoType> values)

public InspectConfig.Builder addAllInfoTypes(Iterable<? extends InfoType> values)

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.

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

Parameter
Name Description
values Iterable<? extends com.google.privacy.dlp.v2.InfoType>
Returns
Type Description
InspectConfig.Builder

addAllMinLikelihoodPerInfoType(Iterable<? extends InspectConfig.InfoTypeLikelihood> values)

public InspectConfig.Builder addAllMinLikelihoodPerInfoType(Iterable<? extends InspectConfig.InfoTypeLikelihood> values)

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
values Iterable<? extends com.google.privacy.dlp.v2.InspectConfig.InfoTypeLikelihood>
Returns
Type Description
InspectConfig.Builder

addAllRuleSet(Iterable<? extends InspectionRuleSet> values)

public InspectConfig.Builder addAllRuleSet(Iterable<? extends InspectionRuleSet> values)

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
values Iterable<? extends com.google.privacy.dlp.v2.InspectionRuleSet>
Returns
Type Description
InspectConfig.Builder

addContentOptions(ContentOption value)

public InspectConfig.Builder addContentOptions(ContentOption value)

Deprecated and unused.

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

Parameter
Name Description
value ContentOption

The contentOptions to add.
Returns
Type Description
InspectConfig.Builder

This builder for chaining.

addContentOptionsValue(int value)

public InspectConfig.Builder addContentOptionsValue(int value)

Deprecated and unused.

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

Parameter
Name Description
value int

The enum numeric value on the wire for contentOptions to add.
Returns
Type Description
InspectConfig.Builder

This builder for chaining.

addCustomInfoTypes(CustomInfoType value)

public InspectConfig.Builder addCustomInfoTypes(CustomInfoType value)

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

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

Parameter
Name Description
value CustomInfoType
Returns
Type Description
InspectConfig.Builder

addCustomInfoTypes(CustomInfoType.Builder builderForValue)

public InspectConfig.Builder addCustomInfoTypes(CustomInfoType.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue CustomInfoType.Builder
Returns
Type Description
InspectConfig.Builder

addCustomInfoTypes(int index, CustomInfoType value)

public InspectConfig.Builder addCustomInfoTypes(int index, CustomInfoType value)

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

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

Parameters
Name Description
index int
value CustomInfoType
Returns
Type Description
InspectConfig.Builder

addCustomInfoTypes(int index, CustomInfoType.Builder builderForValue)

public InspectConfig.Builder addCustomInfoTypes(int index, CustomInfoType.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue CustomInfoType.Builder
Returns
Type Description
InspectConfig.Builder

addCustomInfoTypesBuilder()

public CustomInfoType.Builder addCustomInfoTypesBuilder()

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

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

Returns
Type Description
CustomInfoType.Builder

addCustomInfoTypesBuilder(int index)

public CustomInfoType.Builder addCustomInfoTypesBuilder(int index)

CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/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.Builder

addInfoTypes(InfoType value)

public InspectConfig.Builder addInfoTypes(InfoType value)

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.

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

Parameter
Name Description
value InfoType
Returns
Type Description
InspectConfig.Builder

addInfoTypes(InfoType.Builder builderForValue)

public InspectConfig.Builder addInfoTypes(InfoType.Builder builderForValue)

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.

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

Parameter
Name Description
builderForValue InfoType.Builder
Returns
Type Description
InspectConfig.Builder

addInfoTypes(int index, InfoType value)

public InspectConfig.Builder addInfoTypes(int index, InfoType value)

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.

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

Parameters
Name Description
index int
value InfoType
Returns
Type Description
InspectConfig.Builder

addInfoTypes(int index, InfoType.Builder builderForValue)

public InspectConfig.Builder addInfoTypes(int index, InfoType.Builder builderForValue)

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.

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

Parameters
Name Description
index int
builderForValue InfoType.Builder
Returns
Type Description
InspectConfig.Builder

addInfoTypesBuilder()

public InfoType.Builder addInfoTypesBuilder()

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.

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

Returns
Type Description
InfoType.Builder

addInfoTypesBuilder(int index)

public InfoType.Builder addInfoTypesBuilder(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/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.

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

Parameter
Name Description
index int
Returns
Type Description
InfoType.Builder

addMinLikelihoodPerInfoType(InspectConfig.InfoTypeLikelihood value)

public InspectConfig.Builder addMinLikelihoodPerInfoType(InspectConfig.InfoTypeLikelihood value)

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
value InspectConfig.InfoTypeLikelihood
Returns
Type Description
InspectConfig.Builder

addMinLikelihoodPerInfoType(InspectConfig.InfoTypeLikelihood.Builder builderForValue)

public InspectConfig.Builder addMinLikelihoodPerInfoType(InspectConfig.InfoTypeLikelihood.Builder builderForValue)

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
builderForValue InspectConfig.InfoTypeLikelihood.Builder
Returns
Type Description
InspectConfig.Builder

addMinLikelihoodPerInfoType(int index, InspectConfig.InfoTypeLikelihood value)

public InspectConfig.Builder addMinLikelihoodPerInfoType(int index, InspectConfig.InfoTypeLikelihood value)

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;

Parameters
Name Description
index int
value InspectConfig.InfoTypeLikelihood
Returns
Type Description
InspectConfig.Builder

addMinLikelihoodPerInfoType(int index, InspectConfig.InfoTypeLikelihood.Builder builderForValue)

public InspectConfig.Builder addMinLikelihoodPerInfoType(int index, InspectConfig.InfoTypeLikelihood.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue InspectConfig.InfoTypeLikelihood.Builder
Returns
Type Description
InspectConfig.Builder

addMinLikelihoodPerInfoTypeBuilder()

public InspectConfig.InfoTypeLikelihood.Builder addMinLikelihoodPerInfoTypeBuilder()

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
InspectConfig.InfoTypeLikelihood.Builder

addMinLikelihoodPerInfoTypeBuilder(int index)

public InspectConfig.InfoTypeLikelihood.Builder addMinLikelihoodPerInfoTypeBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public InspectConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
InspectConfig.Builder
Overrides

addRuleSet(InspectionRuleSet value)

public InspectConfig.Builder addRuleSet(InspectionRuleSet value)

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
value InspectionRuleSet
Returns
Type Description
InspectConfig.Builder

addRuleSet(InspectionRuleSet.Builder builderForValue)

public InspectConfig.Builder addRuleSet(InspectionRuleSet.Builder builderForValue)

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
builderForValue InspectionRuleSet.Builder
Returns
Type Description
InspectConfig.Builder

addRuleSet(int index, InspectionRuleSet value)

public InspectConfig.Builder addRuleSet(int index, InspectionRuleSet value)

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;

Parameters
Name Description
index int
value InspectionRuleSet
Returns
Type Description
InspectConfig.Builder

addRuleSet(int index, InspectionRuleSet.Builder builderForValue)

public InspectConfig.Builder addRuleSet(int index, InspectionRuleSet.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue InspectionRuleSet.Builder
Returns
Type Description
InspectConfig.Builder

addRuleSetBuilder()

public InspectionRuleSet.Builder addRuleSetBuilder()

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

addRuleSetBuilder(int index)

public InspectionRuleSet.Builder addRuleSetBuilder(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.Builder

build()

public InspectConfig build()
Returns
Type Description
InspectConfig

buildPartial()

public InspectConfig buildPartial()
Returns
Type Description
InspectConfig

clear()

public InspectConfig.Builder clear()
Returns
Type Description
InspectConfig.Builder
Overrides

clearContentOptions()

public InspectConfig.Builder clearContentOptions()

Deprecated and unused.

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

Returns
Type Description
InspectConfig.Builder

This builder for chaining.

clearCustomInfoTypes()

public InspectConfig.Builder clearCustomInfoTypes()

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

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

Returns
Type Description
InspectConfig.Builder

clearExcludeInfoTypes()

public InspectConfig.Builder clearExcludeInfoTypes()

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

bool exclude_info_types = 5;

Returns
Type Description
InspectConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public InspectConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
InspectConfig.Builder
Overrides

clearIncludeQuote()

public InspectConfig.Builder clearIncludeQuote()

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

This builder for chaining.

clearInfoTypes()

public InspectConfig.Builder clearInfoTypes()

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.

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

Returns
Type Description
InspectConfig.Builder

clearLimits()

public InspectConfig.Builder clearLimits()

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

clearMinLikelihood()

public InspectConfig.Builder clearMinLikelihood()

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

This builder for chaining.

clearMinLikelihoodPerInfoType()

public InspectConfig.Builder clearMinLikelihoodPerInfoType()

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

clearOneof(Descriptors.OneofDescriptor oneof)

public InspectConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
InspectConfig.Builder
Overrides

clearRuleSet()

public InspectConfig.Builder clearRuleSet()

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

clone()

public InspectConfig.Builder clone()
Returns
Type Description
InspectConfig.Builder
Overrides

getContentOptions(int index)

public 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 int getContentOptionsCount()

Deprecated and unused.

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

Returns
Type Description
int

The count of contentOptions.

getContentOptionsList()

public 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 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 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 CustomInfoType getCustomInfoTypes(int index)

CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/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

getCustomInfoTypesBuilder(int index)

public CustomInfoType.Builder getCustomInfoTypesBuilder(int index)

CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/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.Builder

getCustomInfoTypesBuilderList()

public List<CustomInfoType.Builder> getCustomInfoTypesBuilderList()

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

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

Returns
Type Description
List<Builder>

getCustomInfoTypesCount()

public int getCustomInfoTypesCount()

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

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

Returns
Type Description
int

getCustomInfoTypesList()

public List<CustomInfoType> getCustomInfoTypesList()

CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/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 CustomInfoTypeOrBuilder getCustomInfoTypesOrBuilder(int index)

CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/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 List<? extends CustomInfoTypeOrBuilder> getCustomInfoTypesOrBuilderList()

CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/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>

getDefaultInstanceForType()

public InspectConfig getDefaultInstanceForType()
Returns
Type Description
InspectConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getExcludeInfoTypes()

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

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

Parameter
Name Description
index int
Returns
Type Description
InfoType

getInfoTypesBuilder(int index)

public InfoType.Builder getInfoTypesBuilder(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/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.

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

Parameter
Name Description
index int
Returns
Type Description
InfoType.Builder

getInfoTypesBuilderList()

public List<InfoType.Builder> getInfoTypesBuilderList()

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.

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

Returns
Type Description
List<Builder>

getInfoTypesCount()

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

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

Returns
Type Description
int

getInfoTypesList()

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

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

Returns
Type Description
List<InfoType>

getInfoTypesOrBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
InfoTypeOrBuilder

getInfoTypesOrBuilderList()

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

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

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

getLimits()

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

getLimitsBuilder()

public InspectConfig.FindingLimits.Builder getLimitsBuilder()

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

getLimitsOrBuilder()

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

getMinLikelihoodPerInfoTypeBuilder(int index)

public InspectConfig.InfoTypeLikelihood.Builder getMinLikelihoodPerInfoTypeBuilder(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.Builder

getMinLikelihoodPerInfoTypeBuilderList()

public List<InspectConfig.InfoTypeLikelihood.Builder> getMinLikelihoodPerInfoTypeBuilderList()

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

getMinLikelihoodPerInfoTypeCount()

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

getRuleSetBuilder(int index)

public InspectionRuleSet.Builder getRuleSetBuilder(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.Builder

getRuleSetBuilderList()

public List<InspectionRuleSet.Builder> getRuleSetBuilderList()

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

getRuleSetCount()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(InspectConfig other)

public InspectConfig.Builder mergeFrom(InspectConfig other)
Parameter
Name Description
other InspectConfig
Returns
Type Description
InspectConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public InspectConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InspectConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public InspectConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
InspectConfig.Builder
Overrides

mergeLimits(InspectConfig.FindingLimits value)

public InspectConfig.Builder mergeLimits(InspectConfig.FindingLimits value)

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;

Parameter
Name Description
value InspectConfig.FindingLimits
Returns
Type Description
InspectConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final InspectConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
InspectConfig.Builder
Overrides

removeCustomInfoTypes(int index)

public InspectConfig.Builder removeCustomInfoTypes(int index)

CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/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
InspectConfig.Builder

removeInfoTypes(int index)

public InspectConfig.Builder removeInfoTypes(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/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.

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

Parameter
Name Description
index int
Returns
Type Description
InspectConfig.Builder

removeMinLikelihoodPerInfoType(int index)

public InspectConfig.Builder removeMinLikelihoodPerInfoType(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.Builder

removeRuleSet(int index)

public InspectConfig.Builder removeRuleSet(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
InspectConfig.Builder

setContentOptions(int index, ContentOption value)

public InspectConfig.Builder setContentOptions(int index, ContentOption value)

Deprecated and unused.

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

Parameters
Name Description
index int

The index to set the value at.
value ContentOption

The contentOptions to set.
Returns
Type Description
InspectConfig.Builder

This builder for chaining.

setContentOptionsValue(int index, int value)

public InspectConfig.Builder setContentOptionsValue(int index, int value)

Deprecated and unused.

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

Parameters
Name Description
index int

The index to set the value at.
value int

The enum numeric value on the wire for contentOptions to set.
Returns
Type Description
InspectConfig.Builder

This builder for chaining.

setCustomInfoTypes(int index, CustomInfoType value)

public InspectConfig.Builder setCustomInfoTypes(int index, CustomInfoType value)

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

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

Parameters
Name Description
index int
value CustomInfoType
Returns
Type Description
InspectConfig.Builder

setCustomInfoTypes(int index, CustomInfoType.Builder builderForValue)

public InspectConfig.Builder setCustomInfoTypes(int index, CustomInfoType.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue CustomInfoType.Builder
Returns
Type Description
InspectConfig.Builder

setExcludeInfoTypes(boolean value)

public InspectConfig.Builder setExcludeInfoTypes(boolean value)

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

bool exclude_info_types = 5;

Parameter
Name Description
value boolean

The excludeInfoTypes to set.
Returns
Type Description
InspectConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public InspectConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
InspectConfig.Builder
Overrides

setIncludeQuote(boolean value)

public InspectConfig.Builder setIncludeQuote(boolean value)

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;

Parameter
Name Description
value boolean

The includeQuote to set.
Returns
Type Description
InspectConfig.Builder

This builder for chaining.

setInfoTypes(int index, InfoType value)

public InspectConfig.Builder setInfoTypes(int index, InfoType value)

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.

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

Parameters
Name Description
index int
value InfoType
Returns
Type Description
InspectConfig.Builder

setInfoTypes(int index, InfoType.Builder builderForValue)

public InspectConfig.Builder setInfoTypes(int index, InfoType.Builder builderForValue)

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.

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

Parameters
Name Description
index int
builderForValue InfoType.Builder
Returns
Type Description
InspectConfig.Builder

setLimits(InspectConfig.FindingLimits value)

public InspectConfig.Builder setLimits(InspectConfig.FindingLimits value)

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;

Parameter
Name Description
value InspectConfig.FindingLimits
Returns
Type Description
InspectConfig.Builder

setLimits(InspectConfig.FindingLimits.Builder builderForValue)

public InspectConfig.Builder setLimits(InspectConfig.FindingLimits.Builder builderForValue)

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;

Parameter
Name Description
builderForValue InspectConfig.FindingLimits.Builder
Returns
Type Description
InspectConfig.Builder

setMinLikelihood(Likelihood value)

public InspectConfig.Builder setMinLikelihood(Likelihood value)

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;

Parameter
Name Description
value Likelihood

The minLikelihood to set.
Returns
Type Description
InspectConfig.Builder

This builder for chaining.

setMinLikelihoodPerInfoType(int index, InspectConfig.InfoTypeLikelihood value)

public InspectConfig.Builder setMinLikelihoodPerInfoType(int index, InspectConfig.InfoTypeLikelihood value)

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;

Parameters
Name Description
index int
value InspectConfig.InfoTypeLikelihood
Returns
Type Description
InspectConfig.Builder

setMinLikelihoodPerInfoType(int index, InspectConfig.InfoTypeLikelihood.Builder builderForValue)

public InspectConfig.Builder setMinLikelihoodPerInfoType(int index, InspectConfig.InfoTypeLikelihood.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue InspectConfig.InfoTypeLikelihood.Builder
Returns
Type Description
InspectConfig.Builder

setMinLikelihoodValue(int value)

public InspectConfig.Builder setMinLikelihoodValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for minLikelihood to set.
Returns
Type Description
InspectConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public InspectConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
InspectConfig.Builder
Overrides

setRuleSet(int index, InspectionRuleSet value)

public InspectConfig.Builder setRuleSet(int index, InspectionRuleSet value)

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;

Parameters
Name Description
index int
value InspectionRuleSet
Returns
Type Description
InspectConfig.Builder

setRuleSet(int index, InspectionRuleSet.Builder builderForValue)

public InspectConfig.Builder setRuleSet(int index, InspectionRuleSet.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue InspectionRuleSet.Builder
Returns
Type Description
InspectConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final InspectConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
InspectConfig.Builder
Overrides