com.google.api.services.dlp.v2.model

Class GooglePrivacyDlpV2InspectConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dlp.v2.model.GooglePrivacyDlpV2InspectConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GooglePrivacyDlpV2InspectConfig
extends GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Data Loss Prevention (DLP) API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GooglePrivacyDlpV2InspectConfig()

Method Summary

Modifier and Type	Method and Description
GooglePrivacyDlpV2InspectConfig	clone()
List<String>	getContentOptions() List of options defining data content to scan.
List<GooglePrivacyDlpV2CustomInfoType>	getCustomInfoTypes() CustomInfoTypes provided by the user.
Boolean	getExcludeInfoTypes() When true, excludes type information of the findings.
Boolean	getIncludeQuote() When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.
List<GooglePrivacyDlpV2InfoType>	getInfoTypes() Restricts what info_types to look for.
GooglePrivacyDlpV2FindingLimits	getLimits() Configuration to control the number of findings returned.
String	getMinLikelihood() Only returns findings equal or above this threshold.
List<GooglePrivacyDlpV2InspectionRuleSet>	getRuleSet() Set of rules to apply to the findings for this InspectConfig.
GooglePrivacyDlpV2InspectConfig	set(String fieldName, Object value)
GooglePrivacyDlpV2InspectConfig	setContentOptions(List<String> contentOptions) List of options defining data content to scan.
GooglePrivacyDlpV2InspectConfig	setCustomInfoTypes(List<GooglePrivacyDlpV2CustomInfoType> customInfoTypes) CustomInfoTypes provided by the user.
GooglePrivacyDlpV2InspectConfig	setExcludeInfoTypes(Boolean excludeInfoTypes) When true, excludes type information of the findings.
GooglePrivacyDlpV2InspectConfig	setIncludeQuote(Boolean includeQuote) When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.
GooglePrivacyDlpV2InspectConfig	setInfoTypes(List<GooglePrivacyDlpV2InfoType> infoTypes) Restricts what info_types to look for.
GooglePrivacyDlpV2InspectConfig	setLimits(GooglePrivacyDlpV2FindingLimits limits) Configuration to control the number of findings returned.
GooglePrivacyDlpV2InspectConfig	setMinLikelihood(String minLikelihood) Only returns findings equal or above this threshold.
GooglePrivacyDlpV2InspectConfig	setRuleSet(List<GooglePrivacyDlpV2InspectionRuleSet> ruleSet) Set of rules to apply to the findings for this InspectConfig.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GooglePrivacyDlpV2InspectConfig

public GooglePrivacyDlpV2InspectConfig()

Method Detail

getContentOptions

public List<String> getContentOptions()

List of options defining data content to scan. If empty, text, images, and other content will be included.

Returns:

value or null for none

setContentOptions

public GooglePrivacyDlpV2InspectConfig setContentOptions(List<String> contentOptions)

List of options defining data content to scan. If empty, text, images, and other content will be included.

Parameters:

contentOptions - contentOptions or null for none

getCustomInfoTypes

public List<GooglePrivacyDlpV2CustomInfoType> getCustomInfoTypes()

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

Returns:

value or null for none

setCustomInfoTypes

public GooglePrivacyDlpV2InspectConfig setCustomInfoTypes(List<GooglePrivacyDlpV2CustomInfoType> customInfoTypes)

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

Parameters:

customInfoTypes - customInfoTypes or null for none

getExcludeInfoTypes

public Boolean getExcludeInfoTypes()

When true, excludes type information of the findings.

Returns:

value or null for none

setExcludeInfoTypes

public GooglePrivacyDlpV2InspectConfig setExcludeInfoTypes(Boolean excludeInfoTypes)

When true, excludes type information of the findings.

Parameters:

excludeInfoTypes - excludeInfoTypes or null for none

getIncludeQuote

public Boolean getIncludeQuote()

When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

Returns:

value or null for none

setIncludeQuote

public GooglePrivacyDlpV2InspectConfig setIncludeQuote(Boolean includeQuote)

When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

Parameters:

includeQuote - includeQuote or null for none

getInfoTypes

public List<GooglePrivacyDlpV2InfoType> getInfoTypes()

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.

Returns:

value or null for none

setInfoTypes

public GooglePrivacyDlpV2InspectConfig setInfoTypes(List<GooglePrivacyDlpV2InfoType> infoTypes)

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.

Parameters:

infoTypes - infoTypes or null for none

getLimits

public GooglePrivacyDlpV2FindingLimits getLimits()

Configuration to control the number of findings returned.

Returns:

value or null for none

setLimits

public GooglePrivacyDlpV2InspectConfig setLimits(GooglePrivacyDlpV2FindingLimits limits)

Configuration to control the number of findings returned.

Parameters:

limits - limits or null for none

getMinLikelihood

public String getMinLikelihood()

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

Returns:

value or null for none

setMinLikelihood

public GooglePrivacyDlpV2InspectConfig setMinLikelihood(String minLikelihood)

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

Parameters:

minLikelihood - minLikelihood or null for none

getRuleSet

public List<GooglePrivacyDlpV2InspectionRuleSet> getRuleSet()

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.

Returns:

value or null for none

setRuleSet

public GooglePrivacyDlpV2InspectConfig setRuleSet(List<GooglePrivacyDlpV2InspectionRuleSet> ruleSet)

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.

Parameters:

ruleSet - ruleSet or null for none

set

public GooglePrivacyDlpV2InspectConfig set(String fieldName,
                                           Object value)

Overrides:

set in class GenericJson

clone

public GooglePrivacyDlpV2InspectConfig clone()

Overrides:

clone in class GenericJson