Interface IDekRegistryClient

An interface implemented by Confluent DEK Registry clients.

Inherited Members

IDisposable.Dispose()

Namespace: Confluent.SchemaRegistry.Encryption

Assembly: Confluent.SchemaRegistry.Encryption.dll

Syntax

public interface IDekRegistryClient : IDisposable

Properties

MaxCachedKeys

The maximum capacity of the local cache.

Declaration

int MaxCachedKeys { get; }

Property Value

Type	Description
int

Methods

CreateDekAsync(string, Dek)

Create a DEK.

Declaration

Task<RegisteredDek> CreateDekAsync(string kekName, Dek dek)

Parameters

Type	Name	Description
string	kekName
Dek	dek

Returns

Type	Description
Task<RegisteredDek>

CreateKekAsync(Kek)

Create a KEK.

Declaration

Task<RegisteredKek> CreateKekAsync(Kek kek)

Parameters

Type	Name	Description
Kek	kek

Returns

Type	Description
Task<RegisteredKek>

GetDekAsync(string, string, DekFormat?, bool)

Get a DEK.

Declaration

Task<RegisteredDek> GetDekAsync(string kekName, string subject, DekFormat? algorithm, bool ignoreDeletedDeks)

Parameters

Type	Name	Description
string	kekName
string	subject
DekFormat?	algorithm
bool	ignoreDeletedDeks

Returns

Type	Description
Task<RegisteredDek>

GetDekLatestVersionAsync(string, string, DekFormat?, bool)

Get a DEK latest version.

Declaration

Task<RegisteredDek> GetDekLatestVersionAsync(string kekName, string subject, DekFormat? algorithm, bool ignoreDeletedDeks)

Parameters

Type	Name	Description
string	kekName
string	subject
DekFormat?	algorithm
bool	ignoreDeletedDeks

Returns

Type	Description
Task<RegisteredDek>

GetDekVersionAsync(string, string, int, DekFormat?, bool)

Get a DEK version.

Declaration

Task<RegisteredDek> GetDekVersionAsync(string kekName, string subject, int version, DekFormat? algorithm, bool ignoreDeletedDeks)

Parameters

Type	Name	Description
string	kekName
string	subject
int	version
DekFormat?	algorithm
bool	ignoreDeletedDeks

Returns

Type	Description
Task<RegisteredDek>

GetDekVersionsAsync(string, string, DekFormat?, bool)

Get the list of DEK versions.

Declaration

Task<List<int>> GetDekVersionsAsync(string kekName, string subject, DekFormat? algorithm, bool ignoreDeletedDeks)

Parameters

Type	Name	Description
string	kekName
string	subject
DekFormat?	algorithm
bool	ignoreDeletedDeks

Returns

Type	Description
Task<List<int>>

GetDeksAsync(string, bool)

Get the list of DEKs.

Declaration

Task<List<string>> GetDeksAsync(string kekName, bool ignoreDeletedDeks)

Parameters

Type	Name	Description
string	kekName
bool	ignoreDeletedDeks

Returns

Type	Description
Task<List<string>>

GetKekAsync(string, bool)

Get a KEK by name.

Declaration

Task<RegisteredKek> GetKekAsync(string name, bool ignoreDeletedKeks)

Parameters

Type	Name	Description
string	name
bool	ignoreDeletedKeks

Returns

Type	Description
Task<RegisteredKek>

GetKeksAsync(bool)

Get the list of KEKs.

Declaration

Task<List<string>> GetKeksAsync(bool ignoreDeletedKeks)

Parameters

Type	Name	Description
bool	ignoreDeletedKeks

Returns

Type	Description
Task<List<string>>

UpdateKekAsync(string, UpdateKek)

Update a KEK.

Declaration

Task<RegisteredKek> UpdateKekAsync(string name, UpdateKek kek)

Parameters

Type	Name	Description
string	name
UpdateKek	kek

Returns

Type	Description
Task<RegisteredKek>