com.google.privacy.dlp.v2

Interface CryptoReplaceFfxFpeConfigOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

CryptoReplaceFfxFpeConfig, CryptoReplaceFfxFpeConfig.Builder

public interface CryptoReplaceFfxFpeConfigOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
CryptoReplaceFfxFpeConfig.AlphabetCase	getAlphabetCase()
CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet	getCommonAlphabet() .google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;
int	getCommonAlphabetValue() .google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;
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.
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.
CryptoKey	getCryptoKey() The key used by the encryption algorithm.
CryptoKeyOrBuilder	getCryptoKeyOrBuilder() The key used by the encryption algorithm.
java.lang.String	getCustomAlphabet() This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports.
ByteString	getCustomAlphabetBytes() This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports.
int	getRadix() The native way to select the alphabet.
InfoType	getSurrogateInfoType() The custom infoType to annotate the surrogate with.
InfoTypeOrBuilder	getSurrogateInfoTypeOrBuilder() The custom infoType to annotate the surrogate with.
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.
boolean	hasCryptoKey() The key used by the encryption algorithm.
boolean	hasSurrogateInfoType() The custom infoType to annotate the surrogate with.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasCryptoKey

boolean hasCryptoKey()

 The key used by the encryption algorithm. [required]
 

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

getCryptoKey

CryptoKey getCryptoKey()

 The key used by the encryption algorithm. [required]
 

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

getCryptoKeyOrBuilder

CryptoKeyOrBuilder getCryptoKeyOrBuilder()

 The key used by the encryption algorithm. [required]
 

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

hasContext

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
 1. 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 non-structured `ContentItem`s.
 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;

getContext

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
 1. 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 non-structured `ContentItem`s.
 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;

getContextOrBuilder

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
 1. 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 non-structured `ContentItem`s.
 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;

getCommonAlphabetValue

int getCommonAlphabetValue()

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

getCommonAlphabet

CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet getCommonAlphabet()

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

getCustomAlphabet

java.lang.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, 62].
 This must be encoded as ASCII.
 The order of characters does not matter.
 

string custom_alphabet = 5;

getCustomAlphabetBytes

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, 62].
 This must be encoded as ASCII.
 The order of characters does not matter.
 

string custom_alphabet = 5;

getRadix

int getRadix()

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

int32 radix = 6;

hasSurrogateInfoType

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`](/dlp/docs/reference/rest/v2/InspectConfig#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;

getSurrogateInfoType

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`](/dlp/docs/reference/rest/v2/InspectConfig#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;

getSurrogateInfoTypeOrBuilder

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`](/dlp/docs/reference/rest/v2/InspectConfig#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;

getAlphabetCase

CryptoReplaceFfxFpeConfig.AlphabetCase getAlphabetCase()