CosmosAsyncClientEncryptionKey (Azure SDK for Java Reference Documentation)

java.lang.Object

com.azure.cosmos.CosmosAsyncClientEncryptionKey

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
  
  public String getId()
  
  Get the id of the CosmosAsyncClientEncryptionKey
  
  Returns:
  
  the id of the CosmosAsyncClientEncryptionKey
- read
  
  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
  
  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.