com.azure.cosmos.CosmosAsyncClientEncryptionKey.yml

### YamlMime:JavaType
uid: "com.azure.cosmos.CosmosAsyncClientEncryptionKey"
fullName: "com.azure.cosmos.CosmosAsyncClientEncryptionKey"
name: "CosmosAsyncClientEncryptionKey"
nameWithType: "CosmosAsyncClientEncryptionKey"
summary: "The type Cosmos async client<wbr>Encryption<wbr>Key."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **CosmosAsyncClientEncryptionKey**"
methods:
- uid: "com.azure.cosmos.CosmosAsyncClientEncryptionKey.getId()"
  fullName: "com.azure.cosmos.CosmosAsyncClientEncryptionKey.getId()"
  name: "getId()"
  nameWithType: "CosmosAsyncClientEncryptionKey.getId()"
  summary: "Get the id of the <xref uid=\"com.azure.cosmos.CosmosAsyncClientEncryptionKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosAsyncClientEncryptionKey\"></xref>"
  syntax: "public String getId()"
  desc: "Get the id of the <xref uid=\"com.azure.cosmos.CosmosAsyncClientEncryptionKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosAsyncClientEncryptionKey\"></xref>"
  returns:
    description: "the id of the <xref uid=\"com.azure.cosmos.CosmosAsyncClientEncryptionKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosAsyncClientEncryptionKey\"></xref>"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.CosmosAsyncClientEncryptionKey.read()"
  fullName: "com.azure.cosmos.CosmosAsyncClientEncryptionKey.read()"
  name: "read()"
  nameWithType: "CosmosAsyncClientEncryptionKey.read()"
  summary: "Reads a cosmos client encryption key"
  syntax: "public Mono<CosmosClientEncryptionKeyResponse> read()"
  desc: "Reads a cosmos client encryption key"
  returns:
    description: "a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single resource response with the read client encryption key or an error."
    type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.cosmos.models.CosmosClientEncryptionKeyResponse?alt=com.azure.cosmos.models.CosmosClientEncryptionKeyResponse&text=CosmosClientEncryptionKeyResponse\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.cosmos.CosmosAsyncClientEncryptionKey.replace(com.azure.cosmos.models.CosmosClientEncryptionKeyProperties)"
  fullName: "com.azure.cosmos.CosmosAsyncClientEncryptionKey.replace(CosmosClientEncryptionKeyProperties keyProperties)"
  name: "replace(CosmosClientEncryptionKeyProperties keyProperties)"
  nameWithType: "CosmosAsyncClientEncryptionKey.replace(CosmosClientEncryptionKeyProperties keyProperties)"
  summary: "Replace a cosmos client encryption key."
  parameters:
  - description: "the client encryption key properties to create."
    name: "keyProperties"
    type: "<xref href=\"com.azure.cosmos.models.CosmosClientEncryptionKeyProperties?alt=com.azure.cosmos.models.CosmosClientEncryptionKeyProperties&text=CosmosClientEncryptionKeyProperties\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Mono<CosmosClientEncryptionKeyResponse> replace(CosmosClientEncryptionKeyProperties keyProperties)"
  desc: "Replace a cosmos client encryption key. This method is not meant to be invoked directly. It is used within CosmosEncryptionAsyncDatabase.rewrapClientEncryptionKey"
  returns:
    description: "a <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single resource response with the read client encryption key or an error."
    type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.cosmos.models.CosmosClientEncryptionKeyResponse?alt=com.azure.cosmos.models.CosmosClientEncryptionKeyResponse&text=CosmosClientEncryptionKeyResponse\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "class"
desc: "The type Cosmos async clientEncryptionKey. This contains methods to operate on a cosmos clientEncryptionKey asynchronously"
metadata: {}
package: "com.azure.cosmos"
artifact: com.azure:azure-cosmos:4.63.3