com.google.privacy.dlp.v2beta1

Class CryptoReplaceFfxFpeConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.privacy.dlp.v2beta1.CryptoReplaceFfxFpeConfig

All Implemented Interfaces:

CryptoReplaceFfxFpeConfigOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

public final class CryptoReplaceFfxFpeConfig
extends GeneratedMessageV3
implements CryptoReplaceFfxFpeConfigOrBuilder

 Replaces an identifier with a surrogate using FPE with the FFX
 mode of operation.
 The identifier must be representable by the US-ASCII character set.
 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.
 

Protobuf type google.privacy.dlp.v2beta1.CryptoReplaceFfxFpeConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CryptoReplaceFfxFpeConfig.AlphabetCase
static class	CryptoReplaceFfxFpeConfig.Builder Replaces an identifier with a surrogate using FPE with the FFX mode of operation.
static class	CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet These are commonly used subsets of the alphabet that the FFX mode natively supports.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMON_ALPHABET_FIELD_NUMBER
static int	CONTEXT_FIELD_NUMBER
static int	CRYPTO_KEY_FIELD_NUMBER
static int	CUSTOM_ALPHABET_FIELD_NUMBER
static int	RADIX_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
CryptoReplaceFfxFpeConfig.AlphabetCase	getAlphabetCase()
CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet	getCommonAlphabet() .google.privacy.dlp.v2beta1.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;
int	getCommonAlphabetValue() .google.privacy.dlp.v2beta1.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4;
FieldId	getContext() A context may be used for higher security since the same identifier in two different contexts likely will be given a distinct surrogate.
FieldIdOrBuilder	getContextOrBuilder() A context may be used for higher security since the same identifier in two different contexts likely will be given a distinct 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.
static CryptoReplaceFfxFpeConfig	getDefaultInstance()
CryptoReplaceFfxFpeConfig	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Parser<CryptoReplaceFfxFpeConfig>	getParserForType()
int	getRadix() The native way to select the alphabet.
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
boolean	hasContext() A context may be used for higher security since the same identifier in two different contexts likely will be given a distinct surrogate.
boolean	hasCryptoKey() The key used by the encryption algorithm.
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static CryptoReplaceFfxFpeConfig.Builder	newBuilder()
static CryptoReplaceFfxFpeConfig.Builder	newBuilder(CryptoReplaceFfxFpeConfig prototype)
CryptoReplaceFfxFpeConfig.Builder	newBuilderForType()
protected CryptoReplaceFfxFpeConfig.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static CryptoReplaceFfxFpeConfig	parseDelimitedFrom(java.io.InputStream input)
static CryptoReplaceFfxFpeConfig	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static CryptoReplaceFfxFpeConfig	parseFrom(byte[] data)
static CryptoReplaceFfxFpeConfig	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static CryptoReplaceFfxFpeConfig	parseFrom(java.nio.ByteBuffer data)
static CryptoReplaceFfxFpeConfig	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static CryptoReplaceFfxFpeConfig	parseFrom(ByteString data)
static CryptoReplaceFfxFpeConfig	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static CryptoReplaceFfxFpeConfig	parseFrom(CodedInputStream input)
static CryptoReplaceFfxFpeConfig	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static CryptoReplaceFfxFpeConfig	parseFrom(java.io.InputStream input)
static CryptoReplaceFfxFpeConfig	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<CryptoReplaceFfxFpeConfig>	parser()
CryptoReplaceFfxFpeConfig.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

CRYPTO_KEY_FIELD_NUMBER

public static final int CRYPTO_KEY_FIELD_NUMBER

See Also:

Constant Field Values

CONTEXT_FIELD_NUMBER

public static final int CONTEXT_FIELD_NUMBER

See Also:

Constant Field Values

COMMON_ALPHABET_FIELD_NUMBER

public static final int COMMON_ALPHABET_FIELD_NUMBER

See Also:

Constant Field Values

CUSTOM_ALPHABET_FIELD_NUMBER

public static final int CUSTOM_ALPHABET_FIELD_NUMBER

See Also:

Constant Field Values

RADIX_FIELD_NUMBER

public static final int RADIX_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getAlphabetCase

public CryptoReplaceFfxFpeConfig.AlphabetCase getAlphabetCase()

Specified by:

getAlphabetCase in interface CryptoReplaceFfxFpeConfigOrBuilder

hasCryptoKey

public boolean hasCryptoKey()

 The key used by the encryption algorithm. [required]
 

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

Specified by:

hasCryptoKey in interface CryptoReplaceFfxFpeConfigOrBuilder

getCryptoKey

public CryptoKey getCryptoKey()

 The key used by the encryption algorithm. [required]
 

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

Specified by:

getCryptoKey in interface CryptoReplaceFfxFpeConfigOrBuilder

getCryptoKeyOrBuilder

public CryptoKeyOrBuilder getCryptoKeyOrBuilder()

 The key used by the encryption algorithm. [required]
 

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

Specified by:

getCryptoKeyOrBuilder in interface CryptoReplaceFfxFpeConfigOrBuilder

hasContext

public boolean hasContext()

 A context may be used for higher security since the same
 identifier in two different contexts likely will be given a distinct
 surrogate. The principle is that the likeliness is inversely related
 to the ratio of the number of distinct identifiers per context over the
 number of possible surrogates: As long as this ratio is small, the
 likehood is large.
 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
 This is also known as the 'tweak', as in tweakable encryption.
 

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

Specified by:

hasContext in interface CryptoReplaceFfxFpeConfigOrBuilder

getContext

public FieldId getContext()

 A context may be used for higher security since the same
 identifier in two different contexts likely will be given a distinct
 surrogate. The principle is that the likeliness is inversely related
 to the ratio of the number of distinct identifiers per context over the
 number of possible surrogates: As long as this ratio is small, the
 likehood is large.
 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
 This is also known as the 'tweak', as in tweakable encryption.
 

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

Specified by:

getContext in interface CryptoReplaceFfxFpeConfigOrBuilder

getContextOrBuilder

public FieldIdOrBuilder getContextOrBuilder()

 A context may be used for higher security since the same
 identifier in two different contexts likely will be given a distinct
 surrogate. The principle is that the likeliness is inversely related
 to the ratio of the number of distinct identifiers per context over the
 number of possible surrogates: As long as this ratio is small, the
 likehood is large.
 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
 This is also known as the 'tweak', as in tweakable encryption.
 

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

Specified by:

getContextOrBuilder in interface CryptoReplaceFfxFpeConfigOrBuilder

getCommonAlphabetValue

public int getCommonAlphabetValue()

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

Specified by:

getCommonAlphabetValue in interface CryptoReplaceFfxFpeConfigOrBuilder

getCommonAlphabet

public CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet getCommonAlphabet()

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

Specified by:

getCommonAlphabet in interface CryptoReplaceFfxFpeConfigOrBuilder

getCustomAlphabet

public 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;

Specified by:

getCustomAlphabet in interface CryptoReplaceFfxFpeConfigOrBuilder

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

string custom_alphabet = 5;

Specified by:

getCustomAlphabetBytes in interface CryptoReplaceFfxFpeConfigOrBuilder

getRadix

public int getRadix()

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

int32 radix = 6;

Specified by:

getRadix in interface CryptoReplaceFfxFpeConfigOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static CryptoReplaceFfxFpeConfig parseFrom(java.nio.ByteBuffer data)
                                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CryptoReplaceFfxFpeConfig parseFrom(java.nio.ByteBuffer data,
                                                  ExtensionRegistryLite extensionRegistry)
                                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CryptoReplaceFfxFpeConfig parseFrom(ByteString data)
                                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CryptoReplaceFfxFpeConfig parseFrom(ByteString data,
                                                  ExtensionRegistryLite extensionRegistry)
                                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CryptoReplaceFfxFpeConfig parseFrom(byte[] data)
                                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CryptoReplaceFfxFpeConfig parseFrom(byte[] data,
                                                  ExtensionRegistryLite extensionRegistry)
                                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CryptoReplaceFfxFpeConfig parseFrom(java.io.InputStream input)
                                           throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static CryptoReplaceFfxFpeConfig parseFrom(java.io.InputStream input,
                                                  ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static CryptoReplaceFfxFpeConfig parseDelimitedFrom(java.io.InputStream input)
                                                    throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static CryptoReplaceFfxFpeConfig parseDelimitedFrom(java.io.InputStream input,
                                                           ExtensionRegistryLite extensionRegistry)
                                                    throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static CryptoReplaceFfxFpeConfig parseFrom(CodedInputStream input)
                                           throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static CryptoReplaceFfxFpeConfig parseFrom(CodedInputStream input,
                                                  ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public CryptoReplaceFfxFpeConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static CryptoReplaceFfxFpeConfig.Builder newBuilder()

newBuilder

public static CryptoReplaceFfxFpeConfig.Builder newBuilder(CryptoReplaceFfxFpeConfig prototype)

toBuilder

public CryptoReplaceFfxFpeConfig.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected CryptoReplaceFfxFpeConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static CryptoReplaceFfxFpeConfig getDefaultInstance()

parser

public static Parser<CryptoReplaceFfxFpeConfig> parser()

getParserForType

public Parser<CryptoReplaceFfxFpeConfig> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public CryptoReplaceFfxFpeConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder