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.BuilderImplements
CryptoReplaceFfxFpeConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CryptoReplaceFfxFpeConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |
build()
public CryptoReplaceFfxFpeConfig build()| Type | Description |
| CryptoReplaceFfxFpeConfig |
buildPartial()
public CryptoReplaceFfxFpeConfig buildPartial()| Type | Description |
| CryptoReplaceFfxFpeConfig |
clear()
public CryptoReplaceFfxFpeConfig.Builder clear()| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |
clearAlphabet()
public CryptoReplaceFfxFpeConfig.Builder clearAlphabet()| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |
clearCommonAlphabet()
public CryptoReplaceFfxFpeConfig.Builder clearCommonAlphabet()Common alphabets.
.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;
| 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:
- 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
InfoTypeTransformationis applied to both structured and non-structuredContentItems. 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;
| 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];
| 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;
| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public CryptoReplaceFfxFpeConfig.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public CryptoReplaceFfxFpeConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |
clearRadix()
public CryptoReplaceFfxFpeConfig.Builder clearRadix()The native way to select the alphabet. Must be in the range [2, 95].
int32 radix = 6;
| 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:
\u29ddMY_TOKEN_TYPE
.google.privacy.dlp.v2.InfoType surrogate_info_type = 8;
| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |
clone()
public CryptoReplaceFfxFpeConfig.Builder clone()| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |
getAlphabetCase()
public CryptoReplaceFfxFpeConfig.AlphabetCase getAlphabetCase()| Type | Description |
| CryptoReplaceFfxFpeConfig.AlphabetCase |
getCommonAlphabet()
public CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet getCommonAlphabet()Common alphabets.
.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;
| Type | Description |
| CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet | The commonAlphabet. |
getCommonAlphabetValue()
public int getCommonAlphabetValue()Common alphabets.
.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;
| 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:
- 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
InfoTypeTransformationis applied to both structured and non-structuredContentItems. 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;
| 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:
- 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
InfoTypeTransformationis applied to both structured and non-structuredContentItems. 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;
| 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:
- 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
InfoTypeTransformationis applied to both structured and non-structuredContentItems. 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;
| 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];
| 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];
| 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];
| 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;
| 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;
| Type | Description |
| ByteString | The bytes for customAlphabet. |
getDefaultInstanceForType()
public CryptoReplaceFfxFpeConfig getDefaultInstanceForType()| Type | Description |
| CryptoReplaceFfxFpeConfig |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getRadix()
public int getRadix()The native way to select the alphabet. Must be in the range [2, 95].
int32 radix = 6;
| 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:
\u29ddMY_TOKEN_TYPE
.google.privacy.dlp.v2.InfoType surrogate_info_type = 8;
| 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:
\u29ddMY_TOKEN_TYPE
.google.privacy.dlp.v2.InfoType surrogate_info_type = 8;
| 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:
\u29ddMY_TOKEN_TYPE
.google.privacy.dlp.v2.InfoType surrogate_info_type = 8;
| Type | Description |
| InfoTypeOrBuilder |
hasCommonAlphabet()
public boolean hasCommonAlphabet()Common alphabets.
.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;
| 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:
- 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
InfoTypeTransformationis applied to both structured and non-structuredContentItems. 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;
| 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];
| 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;
| 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;
| 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:
\u29ddMY_TOKEN_TYPE
.google.privacy.dlp.v2.InfoType surrogate_info_type = 8;
| Type | Description |
| boolean | Whether the surrogateInfoType field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
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:
- 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
InfoTypeTransformationis applied to both structured and non-structuredContentItems. 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;
| Name | Description |
| value | FieldId |
| 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];
| Name | Description |
| value | CryptoKey |
| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |
mergeFrom(CryptoReplaceFfxFpeConfig other)
public CryptoReplaceFfxFpeConfig.Builder mergeFrom(CryptoReplaceFfxFpeConfig other)| Name | Description |
| other | CryptoReplaceFfxFpeConfig |
| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CryptoReplaceFfxFpeConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public CryptoReplaceFfxFpeConfig.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |
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:
\u29ddMY_TOKEN_TYPE
.google.privacy.dlp.v2.InfoType surrogate_info_type = 8;
| Name | Description |
| value | InfoType |
| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CryptoReplaceFfxFpeConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |
setCommonAlphabet(CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet value)
public CryptoReplaceFfxFpeConfig.Builder setCommonAlphabet(CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet value)Common alphabets.
.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;
| Name | Description |
| value | CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabetThe commonAlphabet to set. |
| 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;
| Name | Description |
| value | intThe enum numeric value on the wire for commonAlphabet to set. |
| 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:
- 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
InfoTypeTransformationis applied to both structured and non-structuredContentItems. 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;
| Name | Description |
| value | FieldId |
| 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:
- 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
InfoTypeTransformationis applied to both structured and non-structuredContentItems. 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;
| Name | Description |
| builderForValue | FieldId.Builder |
| 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];
| Name | Description |
| value | CryptoKey |
| 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];
| Name | Description |
| builderForValue | CryptoKey.Builder |
| 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;
| Name | Description |
| value | StringThe customAlphabet to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for customAlphabet to set. |
| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public CryptoReplaceFfxFpeConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |
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;
| Name | Description |
| value | intThe radix to set. |
| 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)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |
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:
\u29ddMY_TOKEN_TYPE
.google.privacy.dlp.v2.InfoType surrogate_info_type = 8;
| Name | Description |
| value | InfoType |
| 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:
\u29ddMY_TOKEN_TYPE
.google.privacy.dlp.v2.InfoType surrogate_info_type = 8;
| Name | Description |
| builderForValue | InfoType.Builder |
| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final CryptoReplaceFfxFpeConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| CryptoReplaceFfxFpeConfig.Builder |