Class InspectConfig (3.34.0)

public final class InspectConfig extends GeneratedMessageV3 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 Fields

CONTENT_OPTIONS_FIELD_NUMBER

public static final int CONTENT_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

CUSTOM_INFO_TYPES_FIELD_NUMBER

public static final int CUSTOM_INFO_TYPES_FIELD_NUMBER
Field Value
TypeDescription
int

EXCLUDE_INFO_TYPES_FIELD_NUMBER

public static final int EXCLUDE_INFO_TYPES_FIELD_NUMBER
Field Value
TypeDescription
int

INCLUDE_QUOTE_FIELD_NUMBER

public static final int INCLUDE_QUOTE_FIELD_NUMBER
Field Value
TypeDescription
int

INFO_TYPES_FIELD_NUMBER

public static final int INFO_TYPES_FIELD_NUMBER
Field Value
TypeDescription
int

LIMITS_FIELD_NUMBER

public static final int LIMITS_FIELD_NUMBER
Field Value
TypeDescription
int

MIN_LIKELIHOOD_FIELD_NUMBER

public static final int MIN_LIKELIHOOD_FIELD_NUMBER
Field Value
TypeDescription
int

MIN_LIKELIHOOD_PER_INFO_TYPE_FIELD_NUMBER

public static final int MIN_LIKELIHOOD_PER_INFO_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

RULE_SET_FIELD_NUMBER

public static final int RULE_SET_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static InspectConfig getDefaultInstance()
Returns
TypeDescription
InspectConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static InspectConfig.Builder newBuilder()
Returns
TypeDescription
InspectConfig.Builder

newBuilder(InspectConfig prototype)

public static InspectConfig.Builder newBuilder(InspectConfig prototype)
Parameter
NameDescription
prototypeInspectConfig
Returns
TypeDescription
InspectConfig.Builder

parseDelimitedFrom(InputStream input)

public static InspectConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InspectConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InspectConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InspectConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static InspectConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
InspectConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static InspectConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InspectConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static InspectConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
InspectConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static InspectConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InspectConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static InspectConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
InspectConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static InspectConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InspectConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static InspectConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InspectConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InspectConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InspectConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static InspectConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
InspectConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static InspectConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InspectConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<InspectConfig> parser()
Returns
TypeDescription
Parser<InspectConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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

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

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

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

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

The limits.

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

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

The enum numeric value on the wire for minLikelihood.

getParserForType()

public Parser<InspectConfig> getParserForType()
Returns
TypeDescription
Parser<InspectConfig>
Overrides

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

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>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
boolean

Whether the limits field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public InspectConfig.Builder newBuilderForType()
Returns
TypeDescription
InspectConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected InspectConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
InspectConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public InspectConfig.Builder toBuilder()
Returns
TypeDescription
InspectConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException