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

Class GooglePrivacyDlpV2CryptoDeterministicConfig

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GooglePrivacyDlpV2CryptoDeterministicConfig
extends GenericJson

Pseudonymization method that generates deterministic encryption for the given input. Outputs a base64 encoded representation of the encrypted output. Uses AES-SIV based on the RFC https://tools.ietf.org/html/rfc5297.

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
GooglePrivacyDlpV2CryptoDeterministicConfig()

Method Summary

Modifier and Type	Method and Description
GooglePrivacyDlpV2CryptoDeterministicConfig	clone()
GooglePrivacyDlpV2FieldId	getContext() A context may be used for higher security and maintaining referential integrity such that the same identifier in two different contexts will be given a distinct surrogate.
GooglePrivacyDlpV2CryptoKey	getCryptoKey() The key used by the encryption function.
GooglePrivacyDlpV2InfoType	getSurrogateInfoType() The custom info type to annotate the surrogate with.
GooglePrivacyDlpV2CryptoDeterministicConfig	set(String fieldName, Object value)
GooglePrivacyDlpV2CryptoDeterministicConfig	setContext(GooglePrivacyDlpV2FieldId context) A context may be used for higher security and maintaining referential integrity such that the same identifier in two different contexts will be given a distinct surrogate.
GooglePrivacyDlpV2CryptoDeterministicConfig	setCryptoKey(GooglePrivacyDlpV2CryptoKey cryptoKey) The key used by the encryption function.
GooglePrivacyDlpV2CryptoDeterministicConfig	setSurrogateInfoType(GooglePrivacyDlpV2InfoType surrogateInfoType) The custom info type to annotate the surrogate with.

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

GooglePrivacyDlpV2CryptoDeterministicConfig

public GooglePrivacyDlpV2CryptoDeterministicConfig()

Method Detail

getContext

public GooglePrivacyDlpV2FieldId getContext()

A context may be used for higher security and maintaining referential integrity such that the same identifier in two different contexts will be given a distinct surrogate. The context is appended to plaintext value being encrypted. On decryption the provided context is validated against the value used during encryption. If a context was provided during encryption, same context must be provided during decryption as well. If the context is not set, plaintext would be used as is for encryption. If the context is set but: 1. there is no record present when transforming a given value or 2. the field is not present when transforming a given value, plaintext would be used as is for encryption. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and non-structured `ContentItem`s.

Returns:

value or null for none

setContext

public GooglePrivacyDlpV2CryptoDeterministicConfig setContext(GooglePrivacyDlpV2FieldId context)

A context may be used for higher security and maintaining referential integrity such that the same identifier in two different contexts will be given a distinct surrogate. The context is appended to plaintext value being encrypted. On decryption the provided context is validated against the value used during encryption. If a context was provided during encryption, same context must be provided during decryption as well. If the context is not set, plaintext would be used as is for encryption. If the context is set but: 1. there is no record present when transforming a given value or 2. the field is not present when transforming a given value, plaintext would be used as is for encryption. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and non-structured `ContentItem`s.

Parameters:

context - context or null for none

getCryptoKey

public GooglePrivacyDlpV2CryptoKey getCryptoKey()

The key used by the encryption function.

Returns:

value or null for none

setCryptoKey

public GooglePrivacyDlpV2CryptoDeterministicConfig setCryptoKey(GooglePrivacyDlpV2CryptoKey cryptoKey)

The key used by the encryption function.

Parameters:

cryptoKey - cryptoKey or null for none

getSurrogateInfoType

public GooglePrivacyDlpV2InfoType getSurrogateInfoType()

The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE.

Returns:

value or null for none

setSurrogateInfoType

public GooglePrivacyDlpV2CryptoDeterministicConfig setSurrogateInfoType(GooglePrivacyDlpV2InfoType surrogateInfoType)

The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE.

Parameters:

surrogateInfoType - surrogateInfoType or null for none

set

public GooglePrivacyDlpV2CryptoDeterministicConfig set(String fieldName,
                                                       Object value)

Overrides:

set in class GenericJson

clone

public GooglePrivacyDlpV2CryptoDeterministicConfig clone()

Overrides:

clone in class GenericJson