-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.cosmos.encryption.CosmosEncryptionClient.yml
90 lines (90 loc) · 6.54 KB
/
com.azure.cosmos.encryption.CosmosEncryptionClient.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
### YamlMime:JavaType
uid: "com.azure.cosmos.encryption.CosmosEncryptionClient"
fullName: "com.azure.cosmos.encryption.CosmosEncryptionClient"
name: "CosmosEncryptionClient"
nameWithType: "CosmosEncryptionClient"
summary: "Provides a client-side logical representation of the Azure Cosmos DB service."
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 **CosmosEncryptionClient**</br> implements <a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html\">Closeable</a>"
methods:
- uid: "com.azure.cosmos.encryption.CosmosEncryptionClient.close()"
fullName: "com.azure.cosmos.encryption.CosmosEncryptionClient.close()"
name: "close()"
nameWithType: "CosmosEncryptionClient.close()"
summary: "Close this <xref uid=\"com.azure.cosmos.CosmosClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosClient\"></xref> instance and cleans up the resources."
syntax: "public void close()"
desc: "Close this <xref uid=\"com.azure.cosmos.CosmosClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosClient\"></xref> instance and cleans up the resources."
- uid: "com.azure.cosmos.encryption.CosmosEncryptionClient.getCosmosClient()"
fullName: "com.azure.cosmos.encryption.CosmosEncryptionClient.getCosmosClient()"
name: "getCosmosClient()"
nameWithType: "CosmosEncryptionClient.getCosmosClient()"
syntax: "public CosmosClient getCosmosClient()"
returns:
description: "the Cosmos client"
type: "<xref href=\"com.azure.cosmos.CosmosClient?alt=com.azure.cosmos.CosmosClient&text=CosmosClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.encryption.CosmosEncryptionClient.getCosmosEncryptionDatabase(com.azure.cosmos.CosmosDatabase)"
fullName: "com.azure.cosmos.encryption.CosmosEncryptionClient.getCosmosEncryptionDatabase(CosmosDatabase cosmosDatabase)"
name: "getCosmosEncryptionDatabase(CosmosDatabase cosmosDatabase)"
nameWithType: "CosmosEncryptionClient.getCosmosEncryptionDatabase(CosmosDatabase cosmosDatabase)"
summary: "Gets a database with Encryption capabilities"
parameters:
- description: "original database"
name: "cosmosDatabase"
type: "<xref href=\"com.azure.cosmos.CosmosDatabase?alt=com.azure.cosmos.CosmosDatabase&text=CosmosDatabase\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CosmosEncryptionDatabase getCosmosEncryptionDatabase(CosmosDatabase cosmosDatabase)"
desc: "Gets a database with Encryption capabilities"
returns:
description: "database with encryption capabilities"
type: "<xref href=\"com.azure.cosmos.encryption.CosmosEncryptionDatabase?alt=com.azure.cosmos.encryption.CosmosEncryptionDatabase&text=CosmosEncryptionDatabase\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.encryption.CosmosEncryptionClient.getCosmosEncryptionDatabase(java.lang.String)"
fullName: "com.azure.cosmos.encryption.CosmosEncryptionClient.getCosmosEncryptionDatabase(String databaseId)"
name: "getCosmosEncryptionDatabase(String databaseId)"
nameWithType: "CosmosEncryptionClient.getCosmosEncryptionDatabase(String databaseId)"
summary: "Gets a database with Encryption capabilities"
parameters:
- description: "original database id"
name: "databaseId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CosmosEncryptionDatabase getCosmosEncryptionDatabase(String databaseId)"
desc: "Gets a database with Encryption capabilities"
returns:
description: "database with encryption capabilities"
type: "<xref href=\"com.azure.cosmos.encryption.CosmosEncryptionDatabase?alt=com.azure.cosmos.encryption.CosmosEncryptionDatabase&text=CosmosEncryptionDatabase\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.encryption.CosmosEncryptionClient.getEncryptionKeyWrapProvider()"
fullName: "com.azure.cosmos.encryption.CosmosEncryptionClient.getEncryptionKeyWrapProvider()"
name: "getEncryptionKeyWrapProvider()"
nameWithType: "CosmosEncryptionClient.getEncryptionKeyWrapProvider()"
syntax: "public KeyEncryptionKeyResolver getEncryptionKeyWrapProvider()"
returns:
description: "the key encryption key resolver"
type: "<xref href=\"com.azure.core.cryptography.KeyEncryptionKeyResolver?alt=com.azure.core.cryptography.KeyEncryptionKeyResolver&text=KeyEncryptionKeyResolver\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.encryption.CosmosEncryptionClient.getKeyEncryptionKeyResolverName()"
fullName: "com.azure.cosmos.encryption.CosmosEncryptionClient.getKeyEncryptionKeyResolverName()"
name: "getKeyEncryptionKeyResolverName()"
nameWithType: "CosmosEncryptionClient.getKeyEncryptionKeyResolverName()"
syntax: "public String getKeyEncryptionKeyResolverName()"
returns:
description: "the key encryption key resolver name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
type: "class"
desc: "Provides a client-side logical representation of the Azure Cosmos DB service. Calls to CosmosClient API's are blocked for completion."
implements:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html\">Closeable</a>"
metadata: {}
package: "com.azure.cosmos.encryption"
artifact: com.azure:azure-cosmos-encryption:2.13.0