Interface CryptoReplaceFfxFpeConfigOrBuilder (3.43.0)

public interface CryptoReplaceFfxFpeConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAlphabetCase()

public abstract CryptoReplaceFfxFpeConfig.AlphabetCase getAlphabetCase()

Returns
Type	Description
`CryptoReplaceFfxFpeConfig.AlphabetCase`

getCommonAlphabet()

public abstract CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet getCommonAlphabet()

Common alphabets.

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

Returns
Type	Description
`CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet`	The commonAlphabet.

getCommonAlphabetValue()

public abstract 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 abstract 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:

there is no record present when transforming a given value or
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:
a 64 bit integer is encoded followed by a single byte of value 1
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.

getContextOrBuilder()

public abstract 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:

there is no record present when transforming a given value or
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:
a 64 bit integer is encoded followed by a single byte of value 1
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 abstract 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.

getCryptoKeyOrBuilder()

public abstract 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 abstract 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 abstract ByteString getCustomAlphabetBytes()

string custom_alphabet = 5;

Returns
Type	Description
`ByteString`	The bytes for customAlphabet.

getRadix()

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

getSurrogateInfoTypeOrBuilder()

public abstract InfoTypeOrBuilder getSurrogateInfoTypeOrBuilder()

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.

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

Returns
Type	Description
`InfoTypeOrBuilder`

hasCommonAlphabet()

public abstract 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 abstract 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:

there is no record present when transforming a given value or
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:
a 64 bit integer is encoded followed by a single byte of value 1
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 abstract 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 abstract boolean hasCustomAlphabet()

string custom_alphabet = 5;

Returns
Type	Description
`boolean`	Whether the customAlphabet field is set.

hasRadix()

public abstract 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 abstract boolean hasSurrogateInfoType()

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.

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

Returns
Type	Description
`boolean`	Whether the surrogateInfoType field is set.