Class CryptoDeterministicConfig.Builder (3.28.0)

Version 3.28.0

• 3.57.0 (latest)
• 3.56.0
• 3.55.0
• 3.53.0
• 3.52.0
• 3.51.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.6
• 3.6.7
• 3.5.0
• 3.4.0
• 3.3.2
• 3.2.1
• 3.1.4

public static final class CryptoDeterministicConfig.Builder extends GeneratedMessageV3.Builder<CryptoDeterministicConfig.Builder> implements CryptoDeterministicConfigOrBuilder

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.

Protobuf type google.privacy.dlp.v2.CryptoDeterministicConfig

Inheritance

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

Implements

CryptoDeterministicConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CryptoDeterministicConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CryptoDeterministicConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public CryptoDeterministicConfig build()

Returns
Type	Description
CryptoDeterministicConfig

buildPartial()

public CryptoDeterministicConfig buildPartial()

Returns
Type	Description
CryptoDeterministicConfig

clear()

public CryptoDeterministicConfig.Builder clear()

Returns
Type	Description
CryptoDeterministicConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearContext()

public CryptoDeterministicConfig.Builder clearContext()

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

.google.privacy.dlp.v2.FieldId context = 3;

Returns
Type	Description
CryptoDeterministicConfig.Builder

clearCryptoKey()

public CryptoDeterministicConfig.Builder clearCryptoKey()

The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use.

.google.privacy.dlp.v2.CryptoKey crypto_key = 1;

Returns
Type	Description
CryptoDeterministicConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public CryptoDeterministicConfig.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
CryptoDeterministicConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public CryptoDeterministicConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
CryptoDeterministicConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSurrogateInfoType()

public CryptoDeterministicConfig.Builder clearSurrogateInfoType()

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.

.google.privacy.dlp.v2.InfoType surrogate_info_type = 2;

Returns
Type	Description
CryptoDeterministicConfig.Builder

clone()

public CryptoDeterministicConfig.Builder clone()

Returns
Type	Description
CryptoDeterministicConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getContext()

public FieldId 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 unstructured ContentItems.

.google.privacy.dlp.v2.FieldId context = 3;

Returns
Type	Description
FieldId	The context.

getContextBuilder()

public FieldId.Builder getContextBuilder()

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

.google.privacy.dlp.v2.FieldId context = 3;

Returns
Type	Description
FieldId.Builder

getContextOrBuilder()

public FieldIdOrBuilder getContextOrBuilder()

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

.google.privacy.dlp.v2.FieldId context = 3;

Returns
Type	Description
FieldIdOrBuilder

getCryptoKey()

public CryptoKey getCryptoKey()

The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use.

.google.privacy.dlp.v2.CryptoKey crypto_key = 1;

Returns
Type	Description
CryptoKey	The cryptoKey.

getCryptoKeyBuilder()

public CryptoKey.Builder getCryptoKeyBuilder()

The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use.

.google.privacy.dlp.v2.CryptoKey crypto_key = 1;

Returns
Type	Description
CryptoKey.Builder

getCryptoKeyOrBuilder()

public CryptoKeyOrBuilder getCryptoKeyOrBuilder()

The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use.

.google.privacy.dlp.v2.CryptoKey crypto_key = 1;

Returns
Type	Description
CryptoKeyOrBuilder

getDefaultInstanceForType()

public CryptoDeterministicConfig getDefaultInstanceForType()

Returns
Type	Description
CryptoDeterministicConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getSurrogateInfoType()

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

.google.privacy.dlp.v2.InfoType surrogate_info_type = 2;

Returns
Type	Description
InfoType	The surrogateInfoType.

getSurrogateInfoTypeBuilder()

public InfoType.Builder getSurrogateInfoTypeBuilder()

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.

.google.privacy.dlp.v2.InfoType surrogate_info_type = 2;

Returns
Type	Description
InfoType.Builder

getSurrogateInfoTypeOrBuilder()

public InfoTypeOrBuilder getSurrogateInfoTypeOrBuilder()

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.

.google.privacy.dlp.v2.InfoType surrogate_info_type = 2;

Returns
Type	Description
InfoTypeOrBuilder

hasContext()

public boolean hasContext()

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

.google.privacy.dlp.v2.FieldId context = 3;

Returns
Type	Description
boolean	Whether the context field is set.

hasCryptoKey()

public boolean hasCryptoKey()

The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use.

.google.privacy.dlp.v2.CryptoKey crypto_key = 1;

Returns
Type	Description
boolean	Whether the cryptoKey field is set.

hasSurrogateInfoType()

public boolean hasSurrogateInfoType()

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.

.google.privacy.dlp.v2.InfoType surrogate_info_type = 2;

Returns
Type	Description
boolean	Whether the surrogateInfoType field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeContext(FieldId value)

public CryptoDeterministicConfig.Builder mergeContext(FieldId value)

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

.google.privacy.dlp.v2.FieldId context = 3;

Parameter
Name	Description
value	FieldId

Returns
Type	Description
CryptoDeterministicConfig.Builder

mergeCryptoKey(CryptoKey value)

public CryptoDeterministicConfig.Builder mergeCryptoKey(CryptoKey value)

The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use.

.google.privacy.dlp.v2.CryptoKey crypto_key = 1;

Parameter
Name	Description
value	CryptoKey

Returns
Type	Description
CryptoDeterministicConfig.Builder

mergeFrom(CryptoDeterministicConfig other)

public CryptoDeterministicConfig.Builder mergeFrom(CryptoDeterministicConfig other)

Parameter
Name	Description
other	CryptoDeterministicConfig

Returns
Type	Description
CryptoDeterministicConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CryptoDeterministicConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CryptoDeterministicConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public CryptoDeterministicConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
CryptoDeterministicConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeSurrogateInfoType(InfoType value)

public CryptoDeterministicConfig.Builder mergeSurrogateInfoType(InfoType value)

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.

.google.privacy.dlp.v2.InfoType surrogate_info_type = 2;

Parameter
Name	Description
value	InfoType

Returns
Type	Description
CryptoDeterministicConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CryptoDeterministicConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CryptoDeterministicConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setContext(FieldId value)

public CryptoDeterministicConfig.Builder setContext(FieldId value)

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

.google.privacy.dlp.v2.FieldId context = 3;

Parameter
Name	Description
value	FieldId

Returns
Type	Description
CryptoDeterministicConfig.Builder

setContext(FieldId.Builder builderForValue)

public CryptoDeterministicConfig.Builder setContext(FieldId.Builder builderForValue)

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

.google.privacy.dlp.v2.FieldId context = 3;

Parameter
Name	Description
builderForValue	FieldId.Builder

Returns
Type	Description
CryptoDeterministicConfig.Builder

setCryptoKey(CryptoKey value)

public CryptoDeterministicConfig.Builder setCryptoKey(CryptoKey value)

The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use.

.google.privacy.dlp.v2.CryptoKey crypto_key = 1;

Parameter
Name	Description
value	CryptoKey

Returns
Type	Description
CryptoDeterministicConfig.Builder

setCryptoKey(CryptoKey.Builder builderForValue)

public CryptoDeterministicConfig.Builder setCryptoKey(CryptoKey.Builder builderForValue)

The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use.

.google.privacy.dlp.v2.CryptoKey crypto_key = 1;

Parameter
Name	Description
builderForValue	CryptoKey.Builder

Returns
Type	Description
CryptoDeterministicConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CryptoDeterministicConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CryptoDeterministicConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
CryptoDeterministicConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSurrogateInfoType(InfoType value)

public CryptoDeterministicConfig.Builder setSurrogateInfoType(InfoType value)

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.

.google.privacy.dlp.v2.InfoType surrogate_info_type = 2;

Parameter
Name	Description
value	InfoType

Returns
Type	Description
CryptoDeterministicConfig.Builder

setSurrogateInfoType(InfoType.Builder builderForValue)

public CryptoDeterministicConfig.Builder setSurrogateInfoType(InfoType.Builder builderForValue)

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.

.google.privacy.dlp.v2.InfoType surrogate_info_type = 2;

Parameter
Name	Description
builderForValue	InfoType.Builder

Returns
Type	Description
CryptoDeterministicConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final CryptoDeterministicConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CryptoDeterministicConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)