org.tikv.kvproto

Interface Encryptionpb.EncryptedContentOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Encryptionpb.EncryptedContent, Encryptionpb.EncryptedContent.Builder

Enclosing class:

Encryptionpb

public static interface Encryptionpb.EncryptedContentOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsMetadata(String key) Metadata of the encrypted content.
com.google.protobuf.ByteString	getCiphertextKey() Encrypted data key generated by KMS and used to actually encrypt data.
com.google.protobuf.ByteString	getContent() Encrypted content.
com.google.protobuf.ByteString	getIv() Initilization vector (IV) used.
Encryptionpb.MasterKey	getMasterKey() Master key used to encrypt the content.
Encryptionpb.MasterKeyOrBuilder	getMasterKeyOrBuilder() Master key used to encrypt the content.
Map<String,com.google.protobuf.ByteString>	getMetadata() Deprecated.
int	getMetadataCount() Metadata of the encrypted content.
Map<String,com.google.protobuf.ByteString>	getMetadataMap() Metadata of the encrypted content.
com.google.protobuf.ByteString	getMetadataOrDefault(String key, com.google.protobuf.ByteString defaultValue) Metadata of the encrypted content.
com.google.protobuf.ByteString	getMetadataOrThrow(String key) Metadata of the encrypted content.
boolean	hasMasterKey() Master key used to encrypt the content.

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

getMetadataCount

int getMetadataCount()

 Metadata of the encrypted content.
 Eg. IV, method and KMS key ID
 It is preferred to define new fields for extra metadata than using this metadata map.
 

map<string, bytes> metadata = 1;

containsMetadata

boolean containsMetadata(String key)

 Metadata of the encrypted content.
 Eg. IV, method and KMS key ID
 It is preferred to define new fields for extra metadata than using this metadata map.
 

map<string, bytes> metadata = 1;

getMetadata

@Deprecated
Map<String,com.google.protobuf.ByteString> getMetadata()

Deprecated.

Use getMetadataMap() instead.

getMetadataMap

Map<String,com.google.protobuf.ByteString> getMetadataMap()

 Metadata of the encrypted content.
 Eg. IV, method and KMS key ID
 It is preferred to define new fields for extra metadata than using this metadata map.
 

map<string, bytes> metadata = 1;

getMetadataOrDefault

com.google.protobuf.ByteString getMetadataOrDefault(String key,
                                                    com.google.protobuf.ByteString defaultValue)

 Metadata of the encrypted content.
 Eg. IV, method and KMS key ID
 It is preferred to define new fields for extra metadata than using this metadata map.
 

map<string, bytes> metadata = 1;

getMetadataOrThrow

com.google.protobuf.ByteString getMetadataOrThrow(String key)

 Metadata of the encrypted content.
 Eg. IV, method and KMS key ID
 It is preferred to define new fields for extra metadata than using this metadata map.
 

map<string, bytes> metadata = 1;

getContent

com.google.protobuf.ByteString getContent()

 Encrypted content.
 

bytes content = 2;

Returns:

The content.

hasMasterKey

boolean hasMasterKey()

 Master key used to encrypt the content.
 

.encryptionpb.MasterKey master_key = 3;

Returns:

Whether the masterKey field is set.

getMasterKey

Encryptionpb.MasterKey getMasterKey()

 Master key used to encrypt the content.
 

.encryptionpb.MasterKey master_key = 3;

Returns:

The masterKey.

getMasterKeyOrBuilder

Encryptionpb.MasterKeyOrBuilder getMasterKeyOrBuilder()

 Master key used to encrypt the content.
 

.encryptionpb.MasterKey master_key = 3;

getIv

com.google.protobuf.ByteString getIv()

 Initilization vector (IV) used.
 

bytes iv = 4;

Returns:

The iv.

getCiphertextKey

com.google.protobuf.ByteString getCiphertextKey()

 Encrypted data key generated by KMS and used to actually encrypt data.
 Valid only when KMS is used.
 

bytes ciphertext_key = 5;

Returns:

The ciphertextKey.