Class CryptoReplaceFfxFpeConfig.Builder (3.37.0)

Version 3.37.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 CryptoReplaceFfxFpeConfig.Builder extends GeneratedMessageV3.Builder<CryptoReplaceFfxFpeConfig.Builder> implements CryptoReplaceFfxFpeConfigOrBuilder

Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the ReidentifyContent API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/dlp/docs/pseudonymization to learn more.

Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity.

Protobuf type google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig

Inheritance

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

Implements

CryptoReplaceFfxFpeConfigOrBuilder

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)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(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 CryptoReplaceFfxFpeConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

Overrides

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

build()

public CryptoReplaceFfxFpeConfig build()

Returns
Type	Description
CryptoReplaceFfxFpeConfig

buildPartial()

public CryptoReplaceFfxFpeConfig buildPartial()

Returns
Type	Description
CryptoReplaceFfxFpeConfig

clear()

public CryptoReplaceFfxFpeConfig.Builder clear()

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAlphabet()

public CryptoReplaceFfxFpeConfig.Builder clearAlphabet()

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

clearCommonAlphabet()

public CryptoReplaceFfxFpeConfig.Builder clearCommonAlphabet()

Common alphabets.

.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder	This builder for chaining.

clearContext()

public CryptoReplaceFfxFpeConfig.Builder clearContext()

The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used.

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,

   a default tweak will be used.

   Note that case (1) is expected when an InfoTypeTransformation is applied to both structured and unstructured ContentItems. Currently, the referenced field may be of value type integer or string.

   The tweak is constructed as a sequence of bytes in big endian byte order such that:

3. a 64 bit integer is encoded followed by a single byte of value 1

4. a string is encoded in UTF-8 format followed by a single byte of value 2

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

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

clearCryptoKey()

public CryptoReplaceFfxFpeConfig.Builder clearCryptoKey()

Required. The key used by the encryption algorithm.

.google.privacy.dlp.v2.CryptoKey crypto_key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

clearCustomAlphabet()

public CryptoReplaceFfxFpeConfig.Builder clearCustomAlphabet()

This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: <code>0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/</code>

string custom_alphabet = 5;

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CryptoReplaceFfxFpeConfig.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public CryptoReplaceFfxFpeConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

Overrides

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

clearRadix()

public CryptoReplaceFfxFpeConfig.Builder clearRadix()

The native way to select the alphabet. Must be in the range [2, 95].

int32 radix = 6;

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder	This builder for chaining.

clearSurrogateInfoType()

public CryptoReplaceFfxFpeConfig.Builder clearSurrogateInfoType()

The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType 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 infoType 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 infoType SurrogateType. This facilitates reversal of the surrogate when it occurs in free text.

In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType 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 = 8;

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

clone()

public CryptoReplaceFfxFpeConfig.Builder clone()

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAlphabetCase()

public CryptoReplaceFfxFpeConfig.AlphabetCase getAlphabetCase()

Returns
Type	Description
CryptoReplaceFfxFpeConfig.AlphabetCase

getCommonAlphabet()

public CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet getCommonAlphabet()

Common alphabets.

.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;

Returns
Type	Description
CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet	The commonAlphabet.

getCommonAlphabetValue()

public int getCommonAlphabetValue()

Common alphabets.

.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;

Returns
Type	Description
int	The enum numeric value on the wire for commonAlphabet.

getContext()

public FieldId getContext()

The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used.

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,

   a default tweak will be used.

   Note that case (1) is expected when an InfoTypeTransformation is applied to both structured and unstructured ContentItems. Currently, the referenced field may be of value type integer or string.

   The tweak is constructed as a sequence of bytes in big endian byte order such that:

3. a 64 bit integer is encoded followed by a single byte of value 1

4. a string is encoded in UTF-8 format followed by a single byte of value 2

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

Returns
Type	Description
FieldId	The context.

getContextBuilder()

public FieldId.Builder getContextBuilder()

The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used.

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,

   a default tweak will be used.

   Note that case (1) is expected when an InfoTypeTransformation is applied to both structured and unstructured ContentItems. Currently, the referenced field may be of value type integer or string.

   The tweak is constructed as a sequence of bytes in big endian byte order such that:

3. a 64 bit integer is encoded followed by a single byte of value 1

4. a string is encoded in UTF-8 format followed by a single byte of value 2

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

Returns
Type	Description
FieldId.Builder

getContextOrBuilder()

public FieldIdOrBuilder getContextOrBuilder()

The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used.

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,

   a default tweak will be used.

   Note that case (1) is expected when an InfoTypeTransformation is applied to both structured and unstructured ContentItems. Currently, the referenced field may be of value type integer or string.

   The tweak is constructed as a sequence of bytes in big endian byte order such that:

3. a 64 bit integer is encoded followed by a single byte of value 1

4. a string is encoded in UTF-8 format followed by a single byte of value 2

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

Returns
Type	Description
FieldIdOrBuilder

getCryptoKey()

public CryptoKey getCryptoKey()

Required. The key used by the encryption algorithm.

.google.privacy.dlp.v2.CryptoKey crypto_key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
CryptoKey	The cryptoKey.

getCryptoKeyBuilder()

public CryptoKey.Builder getCryptoKeyBuilder()

Required. The key used by the encryption algorithm.

.google.privacy.dlp.v2.CryptoKey crypto_key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
CryptoKey.Builder

getCryptoKeyOrBuilder()

public CryptoKeyOrBuilder getCryptoKeyOrBuilder()

Required. The key used by the encryption algorithm.

.google.privacy.dlp.v2.CryptoKey crypto_key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
CryptoKeyOrBuilder

getCustomAlphabet()

public String getCustomAlphabet()

This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: <code>0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/</code>

string custom_alphabet = 5;

Returns
Type	Description
String	The customAlphabet.

getCustomAlphabetBytes()

public ByteString getCustomAlphabetBytes()

This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: <code>0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/</code>

string custom_alphabet = 5;

Returns
Type	Description
ByteString	The bytes for customAlphabet.

getDefaultInstanceForType()

public CryptoReplaceFfxFpeConfig getDefaultInstanceForType()

Returns
Type	Description
CryptoReplaceFfxFpeConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getRadix()

public int getRadix()

The native way to select the alphabet. Must be in the range [2, 95].

int32 radix = 6;

Returns
Type	Description
int	The radix.

getSurrogateInfoType()

public InfoType getSurrogateInfoType()

The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType 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 infoType 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 infoType SurrogateType. This facilitates reversal of the surrogate when it occurs in free text.

In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType 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 = 8;

Returns
Type	Description
InfoType	The surrogateInfoType.

getSurrogateInfoTypeBuilder()

public InfoType.Builder getSurrogateInfoTypeBuilder()

The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType 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 infoType 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 infoType SurrogateType. This facilitates reversal of the surrogate when it occurs in free text.

In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType 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 = 8;

Returns
Type	Description
InfoType.Builder

getSurrogateInfoTypeOrBuilder()

public InfoTypeOrBuilder getSurrogateInfoTypeOrBuilder()

The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType 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 infoType 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 infoType SurrogateType. This facilitates reversal of the surrogate when it occurs in free text.

In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType 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 = 8;

Returns
Type	Description
InfoTypeOrBuilder

hasCommonAlphabet()

public boolean hasCommonAlphabet()

Common alphabets.

.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;

Returns
Type	Description
boolean	Whether the commonAlphabet field is set.

hasContext()

public boolean hasContext()

The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used.

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,

   a default tweak will be used.

   Note that case (1) is expected when an InfoTypeTransformation is applied to both structured and unstructured ContentItems. Currently, the referenced field may be of value type integer or string.

   The tweak is constructed as a sequence of bytes in big endian byte order such that:

3. a 64 bit integer is encoded followed by a single byte of value 1

4. a string is encoded in UTF-8 format followed by a single byte of value 2

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

Returns
Type	Description
boolean	Whether the context field is set.

hasCryptoKey()

public boolean hasCryptoKey()

Required. The key used by the encryption algorithm.

.google.privacy.dlp.v2.CryptoKey crypto_key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the cryptoKey field is set.

hasCustomAlphabet()

public boolean hasCustomAlphabet()

This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: <code>0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/</code>

string custom_alphabet = 5;

Returns
Type	Description
boolean	Whether the customAlphabet field is set.

hasRadix()

public boolean hasRadix()

The native way to select the alphabet. Must be in the range [2, 95].

int32 radix = 6;

Returns
Type	Description
boolean	Whether the radix field is set.

hasSurrogateInfoType()

public boolean hasSurrogateInfoType()

The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType 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 infoType 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 infoType SurrogateType. This facilitates reversal of the surrogate when it occurs in free text.

In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType 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 = 8;

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 CryptoReplaceFfxFpeConfig.Builder mergeContext(FieldId value)

The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used.

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,

   a default tweak will be used.

   Note that case (1) is expected when an InfoTypeTransformation is applied to both structured and unstructured ContentItems. Currently, the referenced field may be of value type integer or string.

   The tweak is constructed as a sequence of bytes in big endian byte order such that:

3. a 64 bit integer is encoded followed by a single byte of value 1

4. a string is encoded in UTF-8 format followed by a single byte of value 2

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

Parameter
Name	Description
value	FieldId

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

mergeCryptoKey(CryptoKey value)

public CryptoReplaceFfxFpeConfig.Builder mergeCryptoKey(CryptoKey value)

Required. The key used by the encryption algorithm.

.google.privacy.dlp.v2.CryptoKey crypto_key = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	CryptoKey

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

mergeFrom(CryptoReplaceFfxFpeConfig other)

public CryptoReplaceFfxFpeConfig.Builder mergeFrom(CryptoReplaceFfxFpeConfig other)

Parameter
Name	Description
other	CryptoReplaceFfxFpeConfig

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public CryptoReplaceFfxFpeConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

Overrides

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

mergeSurrogateInfoType(InfoType value)

public CryptoReplaceFfxFpeConfig.Builder mergeSurrogateInfoType(InfoType value)

The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType 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 infoType 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 infoType SurrogateType. This facilitates reversal of the surrogate when it occurs in free text.

In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType 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 = 8;

Parameter
Name	Description
value	InfoType

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CryptoReplaceFfxFpeConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

Overrides

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

setCommonAlphabet(CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet value)

public CryptoReplaceFfxFpeConfig.Builder setCommonAlphabet(CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet value)

Common alphabets.

.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;

Parameter
Name	Description
value	CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet The commonAlphabet to set.

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder	This builder for chaining.

setCommonAlphabetValue(int value)

public CryptoReplaceFfxFpeConfig.Builder setCommonAlphabetValue(int value)

Common alphabets.

.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;

Parameter
Name	Description
value	int The enum numeric value on the wire for commonAlphabet to set.

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder	This builder for chaining.

setContext(FieldId value)

public CryptoReplaceFfxFpeConfig.Builder setContext(FieldId value)

The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used.

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,

   a default tweak will be used.

   Note that case (1) is expected when an InfoTypeTransformation is applied to both structured and unstructured ContentItems. Currently, the referenced field may be of value type integer or string.

   The tweak is constructed as a sequence of bytes in big endian byte order such that:

3. a 64 bit integer is encoded followed by a single byte of value 1

4. a string is encoded in UTF-8 format followed by a single byte of value 2

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

Parameter
Name	Description
value	FieldId

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

setContext(FieldId.Builder builderForValue)

public CryptoReplaceFfxFpeConfig.Builder setContext(FieldId.Builder builderForValue)

The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used.

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,

   a default tweak will be used.

   Note that case (1) is expected when an InfoTypeTransformation is applied to both structured and unstructured ContentItems. Currently, the referenced field may be of value type integer or string.

   The tweak is constructed as a sequence of bytes in big endian byte order such that:

3. a 64 bit integer is encoded followed by a single byte of value 1

4. a string is encoded in UTF-8 format followed by a single byte of value 2

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

Parameter
Name	Description
builderForValue	FieldId.Builder

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

setCryptoKey(CryptoKey value)

public CryptoReplaceFfxFpeConfig.Builder setCryptoKey(CryptoKey value)

Required. The key used by the encryption algorithm.

.google.privacy.dlp.v2.CryptoKey crypto_key = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	CryptoKey

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

setCryptoKey(CryptoKey.Builder builderForValue)

public CryptoReplaceFfxFpeConfig.Builder setCryptoKey(CryptoKey.Builder builderForValue)

Required. The key used by the encryption algorithm.

.google.privacy.dlp.v2.CryptoKey crypto_key = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
builderForValue	CryptoKey.Builder

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

setCustomAlphabet(String value)

public CryptoReplaceFfxFpeConfig.Builder setCustomAlphabet(String value)

This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: <code>0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/</code>

string custom_alphabet = 5;

Parameter
Name	Description
value	String The customAlphabet to set.

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder	This builder for chaining.

setCustomAlphabetBytes(ByteString value)

public CryptoReplaceFfxFpeConfig.Builder setCustomAlphabetBytes(ByteString value)

This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: <code>0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/</code>

string custom_alphabet = 5;

Parameter
Name	Description
value	ByteString The bytes for customAlphabet to set.

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

Overrides

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

setRadix(int value)

public CryptoReplaceFfxFpeConfig.Builder setRadix(int value)

The native way to select the alphabet. Must be in the range [2, 95].

int32 radix = 6;

Parameter
Name	Description
value	int The radix to set.

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

Overrides

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

setSurrogateInfoType(InfoType value)

public CryptoReplaceFfxFpeConfig.Builder setSurrogateInfoType(InfoType value)

The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType 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 infoType 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 infoType SurrogateType. This facilitates reversal of the surrogate when it occurs in free text.

In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType 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 = 8;

Parameter
Name	Description
value	InfoType

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

setSurrogateInfoType(InfoType.Builder builderForValue)

public CryptoReplaceFfxFpeConfig.Builder setSurrogateInfoType(InfoType.Builder builderForValue)

The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType 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 infoType 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 infoType SurrogateType. This facilitates reversal of the surrogate when it occurs in free text.

In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType 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 = 8;

Parameter
Name	Description
builderForValue	InfoType.Builder

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final CryptoReplaceFfxFpeConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CryptoReplaceFfxFpeConfig.Builder

Overrides

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