Class InspectConfig.Builder (3.4.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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.privacy.dlp.v2.ContentOption>

The contentOptions to add.

Returns
TypeDescription
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
NameDescription
valuesIterable<Integer>

The enum numeric values on the wire for contentOptions to add.

Returns
TypeDescription
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/dlp/docs/creating-custom-infotypes to learn more.

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

Parameter
NameDescription
valuesIterable<? extends com.google.privacy.dlp.v2.CustomInfoType>
Returns
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
NameDescription
valuesIterable<? extends com.google.privacy.dlp.v2.InfoType>
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.privacy.dlp.v2.InspectionRuleSet>
Returns
TypeDescription
InspectConfig.Builder

addContentOptions(ContentOption value)

public InspectConfig.Builder addContentOptions(ContentOption value)

Deprecated and unused.

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

Parameter
NameDescription
valueContentOption

The contentOptions to add.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for contentOptions to add.

Returns
TypeDescription
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/dlp/docs/creating-custom-infotypes to learn more.

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

Parameter
NameDescription
valueCustomInfoType
Returns
TypeDescription
InspectConfig.Builder

addCustomInfoTypes(CustomInfoType.Builder builderForValue)

public InspectConfig.Builder addCustomInfoTypes(CustomInfoType.Builder builderForValue)

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
NameDescription
builderForValueCustomInfoType.Builder
Returns
TypeDescription
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/dlp/docs/creating-custom-infotypes to learn more.

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

Parameters
NameDescription
indexint
valueCustomInfoType
Returns
TypeDescription
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/dlp/docs/creating-custom-infotypes to learn more.

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

Parameters
NameDescription
indexint
builderForValueCustomInfoType.Builder
Returns
TypeDescription
InspectConfig.Builder

addCustomInfoTypesBuilder()

public CustomInfoType.Builder addCustomInfoTypesBuilder()

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

addCustomInfoTypesBuilder(int index)

public CustomInfoType.Builder addCustomInfoTypesBuilder(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
NameDescription
indexint
Returns
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
NameDescription
valueInfoType
Returns
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
NameDescription
builderForValueInfoType.Builder
Returns
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
NameDescription
indexint
valueInfoType
Returns
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
NameDescription
indexint
builderForValueInfoType.Builder
Returns
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
NameDescription
indexint
Returns
TypeDescription
InfoType.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public InspectConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueInspectionRuleSet
Returns
TypeDescription
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
NameDescription
builderForValueInspectionRuleSet.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueInspectionRuleSet
Returns
TypeDescription
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
NameDescription
indexint
builderForValueInspectionRuleSet.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
InspectionRuleSet.Builder

build()

public InspectConfig build()
Returns
TypeDescription
InspectConfig

buildPartial()

public InspectConfig buildPartial()
Returns
TypeDescription
InspectConfig

clear()

public InspectConfig.Builder clear()
Returns
TypeDescription
InspectConfig.Builder
Overrides

clearContentOptions()

public InspectConfig.Builder clearContentOptions()

Deprecated and unused.

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

Returns
TypeDescription
InspectConfig.Builder

This builder for chaining.

clearCustomInfoTypes()

public InspectConfig.Builder clearCustomInfoTypes()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public InspectConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
TypeDescription
InspectConfig.Builder

clearLimits()

public InspectConfig.Builder clearLimits()

Configuration to control the number of findings returned. This is not used for data profiling.

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

Returns
TypeDescription
InspectConfig.Builder

clearMinLikelihood()

public InspectConfig.Builder clearMinLikelihood()

Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

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

Returns
TypeDescription
InspectConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public InspectConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
InspectConfig.Builder

clone()

public InspectConfig.Builder clone()
Returns
TypeDescription
InspectConfig.Builder
Overrides

getContentOptions(int index)

public ContentOption getContentOptions(int index)

Deprecated and unused.

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

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
ContentOption

The contentOptions at the given index.

getContentOptionsCount()

public int getContentOptionsCount()

Deprecated and unused.

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

Returns
TypeDescription
int

The count of contentOptions.

getContentOptionsList()

public List<ContentOption> getContentOptionsList()

Deprecated and unused.

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

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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/dlp/docs/creating-custom-infotypes to learn more.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
CustomInfoType

getCustomInfoTypesBuilder(int index)

public CustomInfoType.Builder getCustomInfoTypesBuilder(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
NameDescription
indexint
Returns
TypeDescription
CustomInfoType.Builder

getCustomInfoTypesBuilderList()

public List<CustomInfoType.Builder> getCustomInfoTypesBuilderList()

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

getCustomInfoTypesCount()

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

getCustomInfoTypesList()

public 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
TypeDescription
List<CustomInfoType>

getCustomInfoTypesOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
CustomInfoTypeOrBuilder

getCustomInfoTypesOrBuilderList()

public 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
TypeDescription
List<? extends com.google.privacy.dlp.v2.CustomInfoTypeOrBuilder>

getDefaultInstanceForType()

public InspectConfig getDefaultInstanceForType()
Returns
TypeDescription
InspectConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
NameDescription
indexint
Returns
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
NameDescription
indexint
Returns
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
NameDescription
indexint
Returns
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
TypeDescription
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.

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

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

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

Returns
TypeDescription
InspectConfig.FindingLimits.Builder

getLimitsOrBuilder()

public InspectConfig.FindingLimitsOrBuilder getLimitsOrBuilder()

Configuration to control the number of findings returned. This is not used for data profiling.

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

Returns
TypeDescription
InspectConfig.FindingLimitsOrBuilder

getMinLikelihood()

public Likelihood getMinLikelihood()

Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

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

Returns
TypeDescription
Likelihood

The minLikelihood.

getMinLikelihoodValue()

public int getMinLikelihoodValue()

Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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.

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

Returns
TypeDescription
boolean

Whether the limits field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(InspectConfig other)

public InspectConfig.Builder mergeFrom(InspectConfig other)
Parameter
NameDescription
otherInspectConfig
Returns
TypeDescription
InspectConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public InspectConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InspectConfig.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public InspectConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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.

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

Parameter
NameDescription
valueInspectConfig.FindingLimits
Returns
TypeDescription
InspectConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final InspectConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
InspectConfig.Builder
Overrides

removeCustomInfoTypes(int index)

public InspectConfig.Builder removeCustomInfoTypes(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
NameDescription
indexint
Returns
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueContentOption

The contentOptions to set.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

valueint
Returns
TypeDescription
InspectConfig.Builder

The enum numeric value on the wire of contentOptions at the given index.

setCustomInfoTypes(int index, CustomInfoType value)

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

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;

Parameters
NameDescription
indexint
valueCustomInfoType
Returns
TypeDescription
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/dlp/docs/creating-custom-infotypes to learn more.

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

Parameters
NameDescription
indexint
builderForValueCustomInfoType.Builder
Returns
TypeDescription
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
NameDescription
valueboolean

The excludeInfoTypes to set.

Returns
TypeDescription
InspectConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public InspectConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueboolean

The includeQuote to set.

Returns
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
NameDescription
indexint
valueInfoType
Returns
TypeDescription
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/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. 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
NameDescription
indexint
builderForValueInfoType.Builder
Returns
TypeDescription
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.

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

Parameter
NameDescription
valueInspectConfig.FindingLimits
Returns
TypeDescription
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.

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

Parameter
NameDescription
builderForValueInspectConfig.FindingLimits.Builder
Returns
TypeDescription
InspectConfig.Builder

setMinLikelihood(Likelihood value)

public InspectConfig.Builder setMinLikelihood(Likelihood value)

Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

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

Parameter
NameDescription
valueLikelihood

The minLikelihood to set.

Returns
TypeDescription
InspectConfig.Builder

This builder for chaining.

setMinLikelihoodValue(int value)