Package com.azure.cosmos

Class CosmosAsyncClientEncryptionKey

java.lang.Object

com.azure.cosmos.CosmosAsyncClientEncryptionKey

@Beta(value=V4_14_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public final class CosmosAsyncClientEncryptionKey
extends Object

The type Cosmos async clientEncryptionKey. This contains methods to operate on a cosmos clientEncryptionKey asynchronously

Method Summary

Modifier and Type	Method	Description
String	getId()	Get the id of the CosmosAsyncClientEncryptionKey
Mono<CosmosClientEncryptionKeyResponse>	read()	Reads a cosmos client encryption key
Mono<CosmosClientEncryptionKeyResponse>	replace(CosmosClientEncryptionKeyProperties keyProperties)	Replace a cosmos client encryption key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getId

@Beta(value=V4_14_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public String getId()

Get the id of the CosmosAsyncClientEncryptionKey

Returns:

the id of the CosmosAsyncClientEncryptionKey

read

@Beta(value=V4_14_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public Mono<CosmosClientEncryptionKeyResponse> read()

Reads a cosmos client encryption key

Returns:

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

replace

@Beta(value=V4_14_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public Mono<CosmosClientEncryptionKeyResponse> replace(CosmosClientEncryptionKeyProperties keyProperties)

Replace a cosmos client encryption key. This method is not meant to be invoked directly. It is used within CosmosEncryptionAsyncDatabase.rewrapClientEncryptionKey

Parameters:

keyProperties - the client encryption key properties to create.

Returns:

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