oci-keymanagement 2.56.0 → 2.58.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/client.d.ts +65 -41
- package/lib/client.js +86 -41
- package/lib/client.js.map +1 -1
- package/lib/request/backup-key-request.d.ts +1 -1
- package/lib/request/backup-vault-request.d.ts +1 -1
- package/lib/request/cancel-key-deletion-request.d.ts +1 -1
- package/lib/request/cancel-key-version-deletion-request.d.ts +1 -1
- package/lib/request/cancel-vault-deletion-request.d.ts +1 -1
- package/lib/request/change-key-compartment-request.d.ts +1 -1
- package/lib/request/change-vault-compartment-request.d.ts +1 -1
- package/lib/request/create-key-request.d.ts +1 -1
- package/lib/request/create-key-version-request.d.ts +1 -1
- package/lib/request/create-vault-replica-request.d.ts +1 -1
- package/lib/request/create-vault-request.d.ts +1 -1
- package/lib/request/decrypt-request.d.ts +1 -1
- package/lib/request/delete-vault-replica-request.d.ts +1 -1
- package/lib/request/disable-key-request.d.ts +1 -1
- package/lib/request/enable-key-request.d.ts +1 -1
- package/lib/request/encrypt-request.d.ts +1 -1
- package/lib/request/export-key-request.d.ts +1 -1
- package/lib/request/generate-data-encryption-key-request.d.ts +1 -1
- package/lib/request/get-key-request.d.ts +1 -1
- package/lib/request/get-key-version-request.d.ts +1 -1
- package/lib/request/get-replication-status-request.d.ts +1 -1
- package/lib/request/get-vault-request.d.ts +1 -1
- package/lib/request/get-vault-usage-request.d.ts +1 -1
- package/lib/request/get-wrapping-key-request.d.ts +1 -1
- package/lib/request/import-key-request.d.ts +1 -1
- package/lib/request/import-key-version-request.d.ts +1 -1
- package/lib/request/list-key-versions-request.d.ts +1 -1
- package/lib/request/list-keys-request.d.ts +1 -1
- package/lib/request/list-vault-replicas-request.d.ts +1 -1
- package/lib/request/list-vaults-request.d.ts +1 -1
- package/lib/request/restore-key-from-file-request.d.ts +1 -1
- package/lib/request/restore-key-from-object-store-request.d.ts +1 -1
- package/lib/request/restore-vault-from-file-request.d.ts +1 -1
- package/lib/request/restore-vault-from-object-store-request.d.ts +1 -1
- package/lib/request/schedule-key-deletion-request.d.ts +1 -1
- package/lib/request/schedule-key-version-deletion-request.d.ts +1 -1
- package/lib/request/schedule-vault-deletion-request.d.ts +1 -1
- package/lib/request/sign-request.d.ts +1 -1
- package/lib/request/update-key-request.d.ts +1 -1
- package/lib/request/update-vault-request.d.ts +1 -1
- package/lib/request/verify-request.d.ts +1 -1
- package/package.json +3 -3
package/lib/client.d.ts
CHANGED
|
@@ -26,6 +26,7 @@ export declare enum KmsCryptoApiKeys {
|
|
|
26
26
|
export declare class KmsCryptoClient {
|
|
27
27
|
protected static serviceEndpointTemplate: string;
|
|
28
28
|
protected static endpointServiceName: string;
|
|
29
|
+
protected "_realmSpecificEndpointTemplateEnabled": boolean;
|
|
29
30
|
protected "_endpoint": string;
|
|
30
31
|
protected "_defaultHeaders": any;
|
|
31
32
|
protected "_clientConfiguration": common.ClientConfiguration;
|
|
@@ -44,6 +45,12 @@ export declare class KmsCryptoClient {
|
|
|
44
45
|
*/
|
|
45
46
|
set endpoint(endpoint: string);
|
|
46
47
|
get logger(): import("oci-common/lib/log").Logger;
|
|
48
|
+
/**
|
|
49
|
+
* Determines whether realm specific endpoint should be used or not.
|
|
50
|
+
* Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
|
|
51
|
+
* @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template
|
|
52
|
+
*/
|
|
53
|
+
set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean);
|
|
47
54
|
/**
|
|
48
55
|
* Decrypts data using the given [DecryptDataDetails](https://docs.cloud.oracle.com/api/#/en/key/latest/datatypes/DecryptDataDetails) resource.
|
|
49
56
|
*
|
|
@@ -51,7 +58,7 @@ export declare class KmsCryptoClient {
|
|
|
51
58
|
* @param DecryptRequest
|
|
52
59
|
* @return DecryptResponse
|
|
53
60
|
* @throws OciError when an error occurs
|
|
54
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
61
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/Decrypt.ts.html |here} to see how to use Decrypt API.
|
|
55
62
|
*/
|
|
56
63
|
decrypt(decryptRequest: requests.DecryptRequest): Promise<responses.DecryptResponse>;
|
|
57
64
|
/**
|
|
@@ -62,7 +69,7 @@ export declare class KmsCryptoClient {
|
|
|
62
69
|
* @param EncryptRequest
|
|
63
70
|
* @return EncryptResponse
|
|
64
71
|
* @throws OciError when an error occurs
|
|
65
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
72
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/Encrypt.ts.html |here} to see how to use Encrypt API.
|
|
66
73
|
*/
|
|
67
74
|
encrypt(encryptRequest: requests.EncryptRequest): Promise<responses.EncryptResponse>;
|
|
68
75
|
/**
|
|
@@ -74,7 +81,7 @@ export declare class KmsCryptoClient {
|
|
|
74
81
|
* @param ExportKeyRequest
|
|
75
82
|
* @return ExportKeyResponse
|
|
76
83
|
* @throws OciError when an error occurs
|
|
77
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
84
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/ExportKey.ts.html |here} to see how to use ExportKey API.
|
|
78
85
|
*/
|
|
79
86
|
exportKey(exportKeyRequest: requests.ExportKeyRequest): Promise<responses.ExportKeyResponse>;
|
|
80
87
|
/**
|
|
@@ -84,7 +91,7 @@ export declare class KmsCryptoClient {
|
|
|
84
91
|
* @param GenerateDataEncryptionKeyRequest
|
|
85
92
|
* @return GenerateDataEncryptionKeyResponse
|
|
86
93
|
* @throws OciError when an error occurs
|
|
87
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
94
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/GenerateDataEncryptionKey.ts.html |here} to see how to use GenerateDataEncryptionKey API.
|
|
88
95
|
*/
|
|
89
96
|
generateDataEncryptionKey(generateDataEncryptionKeyRequest: requests.GenerateDataEncryptionKeyRequest): Promise<responses.GenerateDataEncryptionKeyResponse>;
|
|
90
97
|
/**
|
|
@@ -96,7 +103,7 @@ export declare class KmsCryptoClient {
|
|
|
96
103
|
* @param SignRequest
|
|
97
104
|
* @return SignResponse
|
|
98
105
|
* @throws OciError when an error occurs
|
|
99
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
106
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/Sign.ts.html |here} to see how to use Sign API.
|
|
100
107
|
*/
|
|
101
108
|
sign(signRequest: requests.SignRequest): Promise<responses.SignResponse>;
|
|
102
109
|
/**
|
|
@@ -108,7 +115,7 @@ export declare class KmsCryptoClient {
|
|
|
108
115
|
* @param VerifyRequest
|
|
109
116
|
* @return VerifyResponse
|
|
110
117
|
* @throws OciError when an error occurs
|
|
111
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
118
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/Verify.ts.html |here} to see how to use Verify API.
|
|
112
119
|
*/
|
|
113
120
|
verify(verifyRequest: requests.VerifyRequest): Promise<responses.VerifyResponse>;
|
|
114
121
|
}
|
|
@@ -120,6 +127,7 @@ export declare enum KmsManagementApiKeys {
|
|
|
120
127
|
export declare class KmsManagementClient {
|
|
121
128
|
protected static serviceEndpointTemplate: string;
|
|
122
129
|
protected static endpointServiceName: string;
|
|
130
|
+
protected "_realmSpecificEndpointTemplateEnabled": boolean;
|
|
123
131
|
protected "_endpoint": string;
|
|
124
132
|
protected "_defaultHeaders": any;
|
|
125
133
|
protected "_waiters": KmsManagementWaiter;
|
|
@@ -139,6 +147,12 @@ export declare class KmsManagementClient {
|
|
|
139
147
|
*/
|
|
140
148
|
set endpoint(endpoint: string);
|
|
141
149
|
get logger(): import("oci-common/lib/log").Logger;
|
|
150
|
+
/**
|
|
151
|
+
* Determines whether realm specific endpoint should be used or not.
|
|
152
|
+
* Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
|
|
153
|
+
* @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template
|
|
154
|
+
*/
|
|
155
|
+
set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean);
|
|
142
156
|
/**
|
|
143
157
|
* Creates a new KmsManagementWaiter for resources for this service.
|
|
144
158
|
*
|
|
@@ -160,7 +174,7 @@ export declare class KmsManagementClient {
|
|
|
160
174
|
* @param BackupKeyRequest
|
|
161
175
|
* @return BackupKeyResponse
|
|
162
176
|
* @throws OciError when an error occurs
|
|
163
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
177
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/BackupKey.ts.html |here} to see how to use BackupKey API.
|
|
164
178
|
*/
|
|
165
179
|
backupKey(backupKeyRequest: requests.BackupKeyRequest): Promise<responses.BackupKeyResponse>;
|
|
166
180
|
/**
|
|
@@ -177,7 +191,7 @@ export declare class KmsManagementClient {
|
|
|
177
191
|
* @param CancelKeyDeletionRequest
|
|
178
192
|
* @return CancelKeyDeletionResponse
|
|
179
193
|
* @throws OciError when an error occurs
|
|
180
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
194
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/CancelKeyDeletion.ts.html |here} to see how to use CancelKeyDeletion API.
|
|
181
195
|
*/
|
|
182
196
|
cancelKeyDeletion(cancelKeyDeletionRequest: requests.CancelKeyDeletionRequest): Promise<responses.CancelKeyDeletionResponse>;
|
|
183
197
|
/**
|
|
@@ -194,7 +208,7 @@ export declare class KmsManagementClient {
|
|
|
194
208
|
* @param CancelKeyVersionDeletionRequest
|
|
195
209
|
* @return CancelKeyVersionDeletionResponse
|
|
196
210
|
* @throws OciError when an error occurs
|
|
197
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
211
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/CancelKeyVersionDeletion.ts.html |here} to see how to use CancelKeyVersionDeletion API.
|
|
198
212
|
*/
|
|
199
213
|
cancelKeyVersionDeletion(cancelKeyVersionDeletionRequest: requests.CancelKeyVersionDeletionRequest): Promise<responses.CancelKeyVersionDeletionResponse>;
|
|
200
214
|
/**
|
|
@@ -212,7 +226,7 @@ export declare class KmsManagementClient {
|
|
|
212
226
|
* @param ChangeKeyCompartmentRequest
|
|
213
227
|
* @return ChangeKeyCompartmentResponse
|
|
214
228
|
* @throws OciError when an error occurs
|
|
215
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
229
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/ChangeKeyCompartment.ts.html |here} to see how to use ChangeKeyCompartment API.
|
|
216
230
|
*/
|
|
217
231
|
changeKeyCompartment(changeKeyCompartmentRequest: requests.ChangeKeyCompartmentRequest): Promise<responses.ChangeKeyCompartmentResponse>;
|
|
218
232
|
/**
|
|
@@ -227,7 +241,7 @@ export declare class KmsManagementClient {
|
|
|
227
241
|
* @param CreateKeyRequest
|
|
228
242
|
* @return CreateKeyResponse
|
|
229
243
|
* @throws OciError when an error occurs
|
|
230
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
244
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/CreateKey.ts.html |here} to see how to use CreateKey API.
|
|
231
245
|
*/
|
|
232
246
|
createKey(createKeyRequest: requests.CreateKeyRequest): Promise<responses.CreateKeyResponse>;
|
|
233
247
|
/**
|
|
@@ -243,7 +257,7 @@ export declare class KmsManagementClient {
|
|
|
243
257
|
* @param CreateKeyVersionRequest
|
|
244
258
|
* @return CreateKeyVersionResponse
|
|
245
259
|
* @throws OciError when an error occurs
|
|
246
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
260
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/CreateKeyVersion.ts.html |here} to see how to use CreateKeyVersion API.
|
|
247
261
|
*/
|
|
248
262
|
createKeyVersion(createKeyVersionRequest: requests.CreateKeyVersionRequest): Promise<responses.CreateKeyVersionResponse>;
|
|
249
263
|
/**
|
|
@@ -259,7 +273,7 @@ export declare class KmsManagementClient {
|
|
|
259
273
|
* @param DisableKeyRequest
|
|
260
274
|
* @return DisableKeyResponse
|
|
261
275
|
* @throws OciError when an error occurs
|
|
262
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
276
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/DisableKey.ts.html |here} to see how to use DisableKey API.
|
|
263
277
|
*/
|
|
264
278
|
disableKey(disableKeyRequest: requests.DisableKeyRequest): Promise<responses.DisableKeyResponse>;
|
|
265
279
|
/**
|
|
@@ -275,7 +289,7 @@ export declare class KmsManagementClient {
|
|
|
275
289
|
* @param EnableKeyRequest
|
|
276
290
|
* @return EnableKeyResponse
|
|
277
291
|
* @throws OciError when an error occurs
|
|
278
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
292
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/EnableKey.ts.html |here} to see how to use EnableKey API.
|
|
279
293
|
*/
|
|
280
294
|
enableKey(enableKeyRequest: requests.EnableKeyRequest): Promise<responses.EnableKeyResponse>;
|
|
281
295
|
/**
|
|
@@ -290,7 +304,7 @@ export declare class KmsManagementClient {
|
|
|
290
304
|
* @param GetKeyRequest
|
|
291
305
|
* @return GetKeyResponse
|
|
292
306
|
* @throws OciError when an error occurs
|
|
293
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
307
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/GetKey.ts.html |here} to see how to use GetKey API.
|
|
294
308
|
*/
|
|
295
309
|
getKey(getKeyRequest: requests.GetKeyRequest): Promise<responses.GetKeyResponse>;
|
|
296
310
|
/**
|
|
@@ -305,7 +319,7 @@ export declare class KmsManagementClient {
|
|
|
305
319
|
* @param GetKeyVersionRequest
|
|
306
320
|
* @return GetKeyVersionResponse
|
|
307
321
|
* @throws OciError when an error occurs
|
|
308
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
322
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/GetKeyVersion.ts.html |here} to see how to use GetKeyVersion API.
|
|
309
323
|
*/
|
|
310
324
|
getKeyVersion(getKeyVersionRequest: requests.GetKeyVersionRequest): Promise<responses.GetKeyVersionResponse>;
|
|
311
325
|
/**
|
|
@@ -318,7 +332,7 @@ export declare class KmsManagementClient {
|
|
|
318
332
|
* @param GetReplicationStatusRequest
|
|
319
333
|
* @return GetReplicationStatusResponse
|
|
320
334
|
* @throws OciError when an error occurs
|
|
321
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
335
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/GetReplicationStatus.ts.html |here} to see how to use GetReplicationStatus API.
|
|
322
336
|
*/
|
|
323
337
|
getReplicationStatus(getReplicationStatusRequest: requests.GetReplicationStatusRequest): Promise<responses.GetReplicationStatusResponse>;
|
|
324
338
|
/**
|
|
@@ -329,7 +343,7 @@ export declare class KmsManagementClient {
|
|
|
329
343
|
* @param GetWrappingKeyRequest
|
|
330
344
|
* @return GetWrappingKeyResponse
|
|
331
345
|
* @throws OciError when an error occurs
|
|
332
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
346
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/GetWrappingKey.ts.html |here} to see how to use GetWrappingKey API.
|
|
333
347
|
*/
|
|
334
348
|
getWrappingKey(getWrappingKeyRequest: requests.GetWrappingKeyRequest): Promise<responses.GetWrappingKeyResponse>;
|
|
335
349
|
/**
|
|
@@ -341,7 +355,7 @@ export declare class KmsManagementClient {
|
|
|
341
355
|
* @param ImportKeyRequest
|
|
342
356
|
* @return ImportKeyResponse
|
|
343
357
|
* @throws OciError when an error occurs
|
|
344
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
358
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/ImportKey.ts.html |here} to see how to use ImportKey API.
|
|
345
359
|
*/
|
|
346
360
|
importKey(importKeyRequest: requests.ImportKeyRequest): Promise<responses.ImportKeyResponse>;
|
|
347
361
|
/**
|
|
@@ -355,7 +369,7 @@ export declare class KmsManagementClient {
|
|
|
355
369
|
* @param ImportKeyVersionRequest
|
|
356
370
|
* @return ImportKeyVersionResponse
|
|
357
371
|
* @throws OciError when an error occurs
|
|
358
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
372
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/ImportKeyVersion.ts.html |here} to see how to use ImportKeyVersion API.
|
|
359
373
|
*/
|
|
360
374
|
importKeyVersion(importKeyVersionRequest: requests.ImportKeyVersionRequest): Promise<responses.ImportKeyVersionResponse>;
|
|
361
375
|
/**
|
|
@@ -371,7 +385,7 @@ export declare class KmsManagementClient {
|
|
|
371
385
|
* @param ListKeyVersionsRequest
|
|
372
386
|
* @return ListKeyVersionsResponse
|
|
373
387
|
* @throws OciError when an error occurs
|
|
374
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
388
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/ListKeyVersions.ts.html |here} to see how to use ListKeyVersions API.
|
|
375
389
|
*/
|
|
376
390
|
listKeyVersions(listKeyVersionsRequest: requests.ListKeyVersionsRequest): Promise<responses.ListKeyVersionsResponse>;
|
|
377
391
|
/**
|
|
@@ -418,7 +432,7 @@ export declare class KmsManagementClient {
|
|
|
418
432
|
* @param ListKeysRequest
|
|
419
433
|
* @return ListKeysResponse
|
|
420
434
|
* @throws OciError when an error occurs
|
|
421
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
435
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/ListKeys.ts.html |here} to see how to use ListKeys API.
|
|
422
436
|
*/
|
|
423
437
|
listKeys(listKeysRequest: requests.ListKeysRequest): Promise<responses.ListKeysResponse>;
|
|
424
438
|
/**
|
|
@@ -462,7 +476,7 @@ export declare class KmsManagementClient {
|
|
|
462
476
|
* @param RestoreKeyFromFileRequest
|
|
463
477
|
* @return RestoreKeyFromFileResponse
|
|
464
478
|
* @throws OciError when an error occurs
|
|
465
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
479
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/RestoreKeyFromFile.ts.html |here} to see how to use RestoreKeyFromFile API.
|
|
466
480
|
*/
|
|
467
481
|
restoreKeyFromFile(restoreKeyFromFileRequest: requests.RestoreKeyFromFileRequest): Promise<responses.RestoreKeyFromFileResponse>;
|
|
468
482
|
/**
|
|
@@ -474,7 +488,7 @@ export declare class KmsManagementClient {
|
|
|
474
488
|
* @param RestoreKeyFromObjectStoreRequest
|
|
475
489
|
* @return RestoreKeyFromObjectStoreResponse
|
|
476
490
|
* @throws OciError when an error occurs
|
|
477
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
491
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/RestoreKeyFromObjectStore.ts.html |here} to see how to use RestoreKeyFromObjectStore API.
|
|
478
492
|
*/
|
|
479
493
|
restoreKeyFromObjectStore(restoreKeyFromObjectStoreRequest: requests.RestoreKeyFromObjectStoreRequest): Promise<responses.RestoreKeyFromObjectStoreResponse>;
|
|
480
494
|
/**
|
|
@@ -490,7 +504,7 @@ export declare class KmsManagementClient {
|
|
|
490
504
|
* @param ScheduleKeyDeletionRequest
|
|
491
505
|
* @return ScheduleKeyDeletionResponse
|
|
492
506
|
* @throws OciError when an error occurs
|
|
493
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
507
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/ScheduleKeyDeletion.ts.html |here} to see how to use ScheduleKeyDeletion API.
|
|
494
508
|
*/
|
|
495
509
|
scheduleKeyDeletion(scheduleKeyDeletionRequest: requests.ScheduleKeyDeletionRequest): Promise<responses.ScheduleKeyDeletionResponse>;
|
|
496
510
|
/**
|
|
@@ -506,7 +520,7 @@ export declare class KmsManagementClient {
|
|
|
506
520
|
* @param ScheduleKeyVersionDeletionRequest
|
|
507
521
|
* @return ScheduleKeyVersionDeletionResponse
|
|
508
522
|
* @throws OciError when an error occurs
|
|
509
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
523
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/ScheduleKeyVersionDeletion.ts.html |here} to see how to use ScheduleKeyVersionDeletion API.
|
|
510
524
|
*/
|
|
511
525
|
scheduleKeyVersionDeletion(scheduleKeyVersionDeletionRequest: requests.ScheduleKeyVersionDeletionRequest): Promise<responses.ScheduleKeyVersionDeletionResponse>;
|
|
512
526
|
/**
|
|
@@ -523,7 +537,7 @@ export declare class KmsManagementClient {
|
|
|
523
537
|
* @param UpdateKeyRequest
|
|
524
538
|
* @return UpdateKeyResponse
|
|
525
539
|
* @throws OciError when an error occurs
|
|
526
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
540
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/UpdateKey.ts.html |here} to see how to use UpdateKey API.
|
|
527
541
|
*/
|
|
528
542
|
updateKey(updateKeyRequest: requests.UpdateKeyRequest): Promise<responses.UpdateKeyResponse>;
|
|
529
543
|
}
|
|
@@ -535,6 +549,7 @@ export declare enum KmsVaultApiKeys {
|
|
|
535
549
|
export declare class KmsVaultClient {
|
|
536
550
|
protected static serviceEndpointTemplate: string;
|
|
537
551
|
protected static endpointServiceName: string;
|
|
552
|
+
protected "_realmSpecificEndpointTemplateEnabled": boolean;
|
|
538
553
|
protected "_endpoint": string;
|
|
539
554
|
protected "_defaultHeaders": any;
|
|
540
555
|
protected "_waiters": KmsVaultWaiter;
|
|
@@ -542,6 +557,9 @@ export declare class KmsVaultClient {
|
|
|
542
557
|
protected _circuitBreaker: null;
|
|
543
558
|
protected _httpOptions: any;
|
|
544
559
|
targetService: string;
|
|
560
|
+
protected _regionId: string;
|
|
561
|
+
protected "_region": common.Region;
|
|
562
|
+
protected _lastSetRegionOrRegionId: string;
|
|
545
563
|
protected _httpClient: common.HttpClient;
|
|
546
564
|
constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
|
|
547
565
|
/**
|
|
@@ -554,6 +572,12 @@ export declare class KmsVaultClient {
|
|
|
554
572
|
*/
|
|
555
573
|
set endpoint(endpoint: string);
|
|
556
574
|
get logger(): import("oci-common/lib/log").Logger;
|
|
575
|
+
/**
|
|
576
|
+
* Determines whether realm specific endpoint should be used or not.
|
|
577
|
+
* Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
|
|
578
|
+
* @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template
|
|
579
|
+
*/
|
|
580
|
+
set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean);
|
|
557
581
|
/**
|
|
558
582
|
* Sets the region to call (ex, Region.US_PHOENIX_1).
|
|
559
583
|
* Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
|
|
@@ -591,7 +615,7 @@ export declare class KmsVaultClient {
|
|
|
591
615
|
* @param BackupVaultRequest
|
|
592
616
|
* @return BackupVaultResponse
|
|
593
617
|
* @throws OciError when an error occurs
|
|
594
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
618
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/BackupVault.ts.html |here} to see how to use BackupVault API.
|
|
595
619
|
*/
|
|
596
620
|
backupVault(backupVaultRequest: requests.BackupVaultRequest): Promise<responses.BackupVaultResponse>;
|
|
597
621
|
/**
|
|
@@ -609,7 +633,7 @@ export declare class KmsVaultClient {
|
|
|
609
633
|
* @param CancelVaultDeletionRequest
|
|
610
634
|
* @return CancelVaultDeletionResponse
|
|
611
635
|
* @throws OciError when an error occurs
|
|
612
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
636
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/CancelVaultDeletion.ts.html |here} to see how to use CancelVaultDeletion API.
|
|
613
637
|
*/
|
|
614
638
|
cancelVaultDeletion(cancelVaultDeletionRequest: requests.CancelVaultDeletionRequest): Promise<responses.CancelVaultDeletionResponse>;
|
|
615
639
|
/**
|
|
@@ -627,7 +651,7 @@ export declare class KmsVaultClient {
|
|
|
627
651
|
* @param ChangeVaultCompartmentRequest
|
|
628
652
|
* @return ChangeVaultCompartmentResponse
|
|
629
653
|
* @throws OciError when an error occurs
|
|
630
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
654
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/ChangeVaultCompartment.ts.html |here} to see how to use ChangeVaultCompartment API.
|
|
631
655
|
*/
|
|
632
656
|
changeVaultCompartment(changeVaultCompartmentRequest: requests.ChangeVaultCompartmentRequest): Promise<responses.ChangeVaultCompartmentResponse>;
|
|
633
657
|
/**
|
|
@@ -645,7 +669,7 @@ export declare class KmsVaultClient {
|
|
|
645
669
|
* @param CreateVaultRequest
|
|
646
670
|
* @return CreateVaultResponse
|
|
647
671
|
* @throws OciError when an error occurs
|
|
648
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
672
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/CreateVault.ts.html |here} to see how to use CreateVault API.
|
|
649
673
|
*/
|
|
650
674
|
createVault(createVaultRequest: requests.CreateVaultRequest): Promise<responses.CreateVaultResponse>;
|
|
651
675
|
/**
|
|
@@ -664,7 +688,7 @@ export declare class KmsVaultClient {
|
|
|
664
688
|
* @param CreateVaultReplicaRequest
|
|
665
689
|
* @return CreateVaultReplicaResponse
|
|
666
690
|
* @throws OciError when an error occurs
|
|
667
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
691
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/CreateVaultReplica.ts.html |here} to see how to use CreateVaultReplica API.
|
|
668
692
|
*/
|
|
669
693
|
createVaultReplica(createVaultReplicaRequest: requests.CreateVaultReplicaRequest): Promise<responses.CreateVaultReplicaResponse>;
|
|
670
694
|
/**
|
|
@@ -679,7 +703,7 @@ export declare class KmsVaultClient {
|
|
|
679
703
|
* @param DeleteVaultReplicaRequest
|
|
680
704
|
* @return DeleteVaultReplicaResponse
|
|
681
705
|
* @throws OciError when an error occurs
|
|
682
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
706
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/DeleteVaultReplica.ts.html |here} to see how to use DeleteVaultReplica API.
|
|
683
707
|
*/
|
|
684
708
|
deleteVaultReplica(deleteVaultReplicaRequest: requests.DeleteVaultReplicaRequest): Promise<responses.DeleteVaultReplicaResponse>;
|
|
685
709
|
/**
|
|
@@ -694,7 +718,7 @@ export declare class KmsVaultClient {
|
|
|
694
718
|
* @param GetVaultRequest
|
|
695
719
|
* @return GetVaultResponse
|
|
696
720
|
* @throws OciError when an error occurs
|
|
697
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
721
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/GetVault.ts.html |here} to see how to use GetVault API.
|
|
698
722
|
*/
|
|
699
723
|
getVault(getVaultRequest: requests.GetVaultRequest): Promise<responses.GetVaultResponse>;
|
|
700
724
|
/**
|
|
@@ -704,7 +728,7 @@ export declare class KmsVaultClient {
|
|
|
704
728
|
* @param GetVaultUsageRequest
|
|
705
729
|
* @return GetVaultUsageResponse
|
|
706
730
|
* @throws OciError when an error occurs
|
|
707
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
731
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/GetVaultUsage.ts.html |here} to see how to use GetVaultUsage API.
|
|
708
732
|
*/
|
|
709
733
|
getVaultUsage(getVaultUsageRequest: requests.GetVaultUsageRequest): Promise<responses.GetVaultUsageResponse>;
|
|
710
734
|
/**
|
|
@@ -719,7 +743,7 @@ export declare class KmsVaultClient {
|
|
|
719
743
|
* @param ListVaultReplicasRequest
|
|
720
744
|
* @return ListVaultReplicasResponse
|
|
721
745
|
* @throws OciError when an error occurs
|
|
722
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
746
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/ListVaultReplicas.ts.html |here} to see how to use ListVaultReplicas API.
|
|
723
747
|
*/
|
|
724
748
|
listVaultReplicas(listVaultReplicasRequest: requests.ListVaultReplicasRequest): Promise<responses.ListVaultReplicasResponse>;
|
|
725
749
|
/**
|
|
@@ -766,7 +790,7 @@ export declare class KmsVaultClient {
|
|
|
766
790
|
* @param ListVaultsRequest
|
|
767
791
|
* @return ListVaultsResponse
|
|
768
792
|
* @throws OciError when an error occurs
|
|
769
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
793
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/ListVaults.ts.html |here} to see how to use ListVaults API.
|
|
770
794
|
*/
|
|
771
795
|
listVaults(listVaultsRequest: requests.ListVaultsRequest): Promise<responses.ListVaultsResponse>;
|
|
772
796
|
/**
|
|
@@ -810,7 +834,7 @@ export declare class KmsVaultClient {
|
|
|
810
834
|
* @param RestoreVaultFromFileRequest
|
|
811
835
|
* @return RestoreVaultFromFileResponse
|
|
812
836
|
* @throws OciError when an error occurs
|
|
813
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
837
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/RestoreVaultFromFile.ts.html |here} to see how to use RestoreVaultFromFile API.
|
|
814
838
|
*/
|
|
815
839
|
restoreVaultFromFile(restoreVaultFromFileRequest: requests.RestoreVaultFromFileRequest): Promise<responses.RestoreVaultFromFileResponse>;
|
|
816
840
|
/**
|
|
@@ -822,7 +846,7 @@ export declare class KmsVaultClient {
|
|
|
822
846
|
* @param RestoreVaultFromObjectStoreRequest
|
|
823
847
|
* @return RestoreVaultFromObjectStoreResponse
|
|
824
848
|
* @throws OciError when an error occurs
|
|
825
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
849
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/RestoreVaultFromObjectStore.ts.html |here} to see how to use RestoreVaultFromObjectStore API.
|
|
826
850
|
*/
|
|
827
851
|
restoreVaultFromObjectStore(restoreVaultFromObjectStoreRequest: requests.RestoreVaultFromObjectStoreRequest): Promise<responses.RestoreVaultFromObjectStoreResponse>;
|
|
828
852
|
/**
|
|
@@ -841,7 +865,7 @@ export declare class KmsVaultClient {
|
|
|
841
865
|
* @param ScheduleVaultDeletionRequest
|
|
842
866
|
* @return ScheduleVaultDeletionResponse
|
|
843
867
|
* @throws OciError when an error occurs
|
|
844
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
868
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/ScheduleVaultDeletion.ts.html |here} to see how to use ScheduleVaultDeletion API.
|
|
845
869
|
*/
|
|
846
870
|
scheduleVaultDeletion(scheduleVaultDeletionRequest: requests.ScheduleVaultDeletionRequest): Promise<responses.ScheduleVaultDeletionResponse>;
|
|
847
871
|
/**
|
|
@@ -858,7 +882,7 @@ export declare class KmsVaultClient {
|
|
|
858
882
|
* @param UpdateVaultRequest
|
|
859
883
|
* @return UpdateVaultResponse
|
|
860
884
|
* @throws OciError when an error occurs
|
|
861
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
885
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/keymanagement/UpdateVault.ts.html |here} to see how to use UpdateVault API.
|
|
862
886
|
*/
|
|
863
887
|
updateVault(updateVaultRequest: requests.UpdateVaultRequest): Promise<responses.UpdateVaultResponse>;
|
|
864
888
|
}
|