CosmosEncryptionAsyncDatabase Class

Package:

com.azure.cosmos.encryption

Maven Artifact:

com.azure:azure-cosmos-encryption:2.16.0

• java.lang.Object
• • com.azure.cosmos.encryption.CosmosEncryptionAsyncDatabase

public final class CosmosEncryptionAsyncDatabase

CosmosEncryptionAsyncDatabase with encryption capabilities.

Method Summary

Modifier and Type	Method and Description
Mono<CosmosClientEncryptionKeyResponse>	createClientEncryptionKey(String clientEncryptionKeyId, String encryptionAlgorithm, EncryptionKeyWrapMetadata encryptionKeyWrapMetadata) Creates a client encryption key after subscription the operation will be performed.
CosmosAsyncClientEncryptionKey	getClientEncryptionKey(String id) Gets a CosmosAsyncClientEncryptionKey object without making a service call
CosmosAsyncDatabase	getCosmosAsyncDatabase() Gets a regular async database object.
CosmosEncryptionAsyncContainer	getCosmosEncryptionAsyncContainer(CosmosAsyncContainer container) Gets a Container with Encryption capabilities
CosmosEncryptionAsyncContainer	getCosmosEncryptionAsyncContainer(String containerId) Gets a Container with Encryption capabilities
CosmosPagedFlux<CosmosClientEncryptionKeyProperties>	readAllClientEncryptionKeys() Reads all cosmos client encryption keys in a database.
Mono<CosmosClientEncryptionKeyResponse>	rewrapClientEncryptionKey(String clientEncryptionKeyId, EncryptionKeyWrapMetadata newEncryptionKeyWrapMetadata) Rewrap a cosmos client encryption key

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

createClientEncryptionKey

public Mono createClientEncryptionKey(String clientEncryptionKeyId, String encryptionAlgorithm, EncryptionKeyWrapMetadata encryptionKeyWrapMetadata)

Creates a client encryption key after subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the created client encryption key. In case of failure the Mono will error.

Parameters:

clientEncryptionKeyId - Client Encryption Key id.

encryptionAlgorithm - Encryption Algorithm.

encryptionKeyWrapMetadata - EncryptionKeyWrapMetadata.

Returns:

an Mono containing the single resource response with the created cosmos client encryption key or an error.

getClientEncryptionKey

public CosmosAsyncClientEncryptionKey getClientEncryptionKey(String id)

Gets a CosmosAsyncClientEncryptionKey object without making a service call

Parameters:

id - id of the clientEncryptionKey

Returns:

Cosmos ClientEncryptionKey

getCosmosAsyncDatabase

public CosmosAsyncDatabase getCosmosAsyncDatabase()

Gets a regular async database object.

Returns:

regular async database object

getCosmosEncryptionAsyncContainer

public CosmosEncryptionAsyncContainer getCosmosEncryptionAsyncContainer(CosmosAsyncContainer container)

Gets a Container with Encryption capabilities

Parameters:

container - original container

Returns:

container with encryption capabilities

getCosmosEncryptionAsyncContainer

public CosmosEncryptionAsyncContainer getCosmosEncryptionAsyncContainer(String containerId)

Gets a Container with Encryption capabilities

Parameters:

containerId - original container id

Returns:

container with encryption capabilities

readAllClientEncryptionKeys

public CosmosPagedFlux readAllClientEncryptionKeys()

Reads all cosmos client encryption keys in a database.

After subscription the operation will be performed. The CosmosPagedFlux<T> will contain one or several feed response of the read cosmos client encryption keys. In case of failure the CosmosPagedFlux<T> will error.

Returns:

a CosmosPagedFlux<T> containing one or several feed response pages of the read cosmos client encryption keys or an error.

rewrapClientEncryptionKey

public Mono rewrapClientEncryptionKey(String clientEncryptionKeyId, EncryptionKeyWrapMetadata newEncryptionKeyWrapMetadata)

Rewrap a cosmos client encryption key

Parameters:

clientEncryptionKeyId - the client encryption key properties to create.

newEncryptionKeyWrapMetadata - EncryptionKeyWrapMetadata.

Returns:

a Mono containing the single resource response with the read client encryption key or an error.