-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.yml
166 lines (166 loc) · 13 KB
/
com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
### YamlMime:JavaType
uid: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties"
fullName: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties"
name: "CosmosClientEncryptionKeyProperties"
nameWithType: "CosmosClientEncryptionKeyProperties"
summary: "Details of an encryption key for use with 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 **CosmosClientEncryptionKeyProperties**"
constructors:
- uid: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.CosmosClientEncryptionKeyProperties(java.lang.String,java.lang.String,byte[],com.azure.cosmos.models.EncryptionKeyWrapMetadata)"
fullName: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.CosmosClientEncryptionKeyProperties(String id, String encryptionAlgorithm, byte[] wrappedDataEncryptionKey, EncryptionKeyWrapMetadata encryptionKeyWrapMetadata)"
name: "CosmosClientEncryptionKeyProperties(String id, String encryptionAlgorithm, byte[] wrappedDataEncryptionKey, EncryptionKeyWrapMetadata encryptionKeyWrapMetadata)"
nameWithType: "CosmosClientEncryptionKeyProperties.CosmosClientEncryptionKeyProperties(String id, String encryptionAlgorithm, byte[] wrappedDataEncryptionKey, EncryptionKeyWrapMetadata encryptionKeyWrapMetadata)"
summary: "Constructor."
parameters:
- description: "Unique identifier for the client encryption key."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data."
name: "encryptionAlgorithm"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Wrapped (encrypted) form of the client encryption key."
name: "wrappedDataEncryptionKey"
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
- description: "Metadata used by the configured key wrapping provider in order to unwrap the key."
name: "encryptionKeyWrapMetadata"
type: "<xref href=\"com.azure.cosmos.models.EncryptionKeyWrapMetadata?alt=com.azure.cosmos.models.EncryptionKeyWrapMetadata&text=EncryptionKeyWrapMetadata\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CosmosClientEncryptionKeyProperties(String id, String encryptionAlgorithm, byte[] wrappedDataEncryptionKey, EncryptionKeyWrapMetadata encryptionKeyWrapMetadata)"
desc: "Constructor."
methods:
- uid: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.getETag()"
fullName: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.getETag()"
name: "getETag()"
nameWithType: "CosmosClientEncryptionKeyProperties.getETag()"
summary: "Get the entity tag associated with the resource."
syntax: "public String getETag()"
desc: "Get the entity tag associated with the resource. This is only relevant when getting response from the server."
returns:
description: "the e tag."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.getEncryptionAlgorithm()"
fullName: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.getEncryptionAlgorithm()"
name: "getEncryptionAlgorithm()"
nameWithType: "CosmosClientEncryptionKeyProperties.getEncryptionAlgorithm()"
summary: "Gets the encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data."
syntax: "public String getEncryptionAlgorithm()"
desc: "Gets the encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data."
returns:
description: "encryptionAlgorithm"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.getEncryptionKeyWrapMetadata()"
fullName: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.getEncryptionKeyWrapMetadata()"
name: "getEncryptionKeyWrapMetadata()"
nameWithType: "CosmosClientEncryptionKeyProperties.getEncryptionKeyWrapMetadata()"
summary: "Gets the metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key."
syntax: "public EncryptionKeyWrapMetadata getEncryptionKeyWrapMetadata()"
desc: "Gets the metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key."
returns:
description: "encryptionKeyWrapMetadata"
type: "<xref href=\"com.azure.cosmos.models.EncryptionKeyWrapMetadata?alt=com.azure.cosmos.models.EncryptionKeyWrapMetadata&text=EncryptionKeyWrapMetadata\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.getId()"
fullName: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.getId()"
name: "getId()"
nameWithType: "CosmosClientEncryptionKeyProperties.getId()"
summary: "Gets the name of the resource."
syntax: "public String getId()"
desc: "Gets the name of the resource."
returns:
description: "the name of the resource."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.getTimestamp()"
fullName: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.getTimestamp()"
name: "getTimestamp()"
nameWithType: "CosmosClientEncryptionKeyProperties.getTimestamp()"
summary: "Get the last modified timestamp associated with the resource."
syntax: "public Instant getTimestamp()"
desc: "Get the last modified timestamp associated with the resource. This is only relevant when getting response from the server."
returns:
description: "the timestamp."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Instant.html\">Instant</a>"
- uid: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.getWrappedDataEncryptionKey()"
fullName: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.getWrappedDataEncryptionKey()"
name: "getWrappedDataEncryptionKey()"
nameWithType: "CosmosClientEncryptionKeyProperties.getWrappedDataEncryptionKey()"
summary: "Gets the wrapped form of the client encryption key."
syntax: "public byte[] getWrappedDataEncryptionKey()"
desc: "Gets the wrapped form of the client encryption key."
returns:
description: "wrappedDataEncryptionKey"
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
- uid: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.setEncryptionAlgorithm(java.lang.String)"
fullName: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.setEncryptionAlgorithm(String encryptionAlgorithm)"
name: "setEncryptionAlgorithm(String encryptionAlgorithm)"
nameWithType: "CosmosClientEncryptionKeyProperties.setEncryptionAlgorithm(String encryptionAlgorithm)"
summary: "Sets the encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data."
parameters:
- description: "the encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data."
name: "encryptionAlgorithm"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CosmosClientEncryptionKeyProperties setEncryptionAlgorithm(String encryptionAlgorithm)"
desc: "Sets the encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data."
returns:
description: "CosmosClientEncryptionKeyProperties"
type: "<xref href=\"com.azure.cosmos.models.CosmosClientEncryptionKeyProperties?alt=com.azure.cosmos.models.CosmosClientEncryptionKeyProperties&text=CosmosClientEncryptionKeyProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.setEncryptionKeyWrapMetadata(com.azure.cosmos.models.EncryptionKeyWrapMetadata)"
fullName: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.setEncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata encryptionKeyWrapMetadata)"
name: "setEncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata encryptionKeyWrapMetadata)"
nameWithType: "CosmosClientEncryptionKeyProperties.setEncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata encryptionKeyWrapMetadata)"
summary: "Sets the metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key."
parameters:
- description: "the metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key."
name: "encryptionKeyWrapMetadata"
type: "<xref href=\"com.azure.cosmos.models.EncryptionKeyWrapMetadata?alt=com.azure.cosmos.models.EncryptionKeyWrapMetadata&text=EncryptionKeyWrapMetadata\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CosmosClientEncryptionKeyProperties setEncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata encryptionKeyWrapMetadata)"
desc: "Sets the metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key."
returns:
description: "CosmosClientEncryptionKeyProperties"
type: "<xref href=\"com.azure.cosmos.models.CosmosClientEncryptionKeyProperties?alt=com.azure.cosmos.models.CosmosClientEncryptionKeyProperties&text=CosmosClientEncryptionKeyProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.setId(java.lang.String)"
fullName: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.setId(String id)"
name: "setId(String id)"
nameWithType: "CosmosClientEncryptionKeyProperties.setId(String id)"
summary: "Sets the name of the resource."
parameters:
- description: "the name of the resource."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CosmosClientEncryptionKeyProperties setId(String id)"
desc: "Sets the name of the resource."
returns:
description: "the current instance of <xref uid=\"com.azure.cosmos.models.CosmosContainerProperties\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosContainerProperties\"></xref>."
type: "<xref href=\"com.azure.cosmos.models.CosmosClientEncryptionKeyProperties?alt=com.azure.cosmos.models.CosmosClientEncryptionKeyProperties&text=CosmosClientEncryptionKeyProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.setWrappedDataEncryptionKey(byte[])"
fullName: "com.azure.cosmos.models.CosmosClientEncryptionKeyProperties.setWrappedDataEncryptionKey(byte[] wrappedDataEncryptionKey)"
name: "setWrappedDataEncryptionKey(byte[] wrappedDataEncryptionKey)"
nameWithType: "CosmosClientEncryptionKeyProperties.setWrappedDataEncryptionKey(byte[] wrappedDataEncryptionKey)"
summary: "Sets the wrapped form of the client encryption key."
parameters:
- description: "the wrapped form of the client encryption key."
name: "wrappedDataEncryptionKey"
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
syntax: "public CosmosClientEncryptionKeyProperties setWrappedDataEncryptionKey(byte[] wrappedDataEncryptionKey)"
desc: "Sets the wrapped form of the client encryption key."
returns:
description: "CosmosClientEncryptionKeyProperties"
type: "<xref href=\"com.azure.cosmos.models.CosmosClientEncryptionKeyProperties?alt=com.azure.cosmos.models.CosmosClientEncryptionKeyProperties&text=CosmosClientEncryptionKeyProperties\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Details of an encryption key for use with the Azure Cosmos DB service."
metadata: {}
package: "com.azure.cosmos.models"
artifact: com.azure:azure-cosmos:4.62.0