oci-keymanagement 2.57.0 → 2.59.0
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.js
CHANGED
|
@@ -60,6 +60,7 @@ var KmsCryptoApiKeys;
|
|
|
60
60
|
*/
|
|
61
61
|
class KmsCryptoClient {
|
|
62
62
|
constructor(params, clientConfiguration) {
|
|
63
|
+
this["_realmSpecificEndpointTemplateEnabled"] = false;
|
|
63
64
|
this["_endpoint"] = "";
|
|
64
65
|
this["_defaultHeaders"] = {};
|
|
65
66
|
this._circuitBreaker = null;
|
|
@@ -106,6 +107,16 @@ class KmsCryptoClient {
|
|
|
106
107
|
get logger() {
|
|
107
108
|
return common.LOG.logger;
|
|
108
109
|
}
|
|
110
|
+
/**
|
|
111
|
+
* Determines whether realm specific endpoint should be used or not.
|
|
112
|
+
* Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
|
|
113
|
+
* @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template
|
|
114
|
+
*/
|
|
115
|
+
set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled) {
|
|
116
|
+
this._realmSpecificEndpointTemplateEnabled = realmSpecificEndpointTemplateEnabled;
|
|
117
|
+
if (this.logger)
|
|
118
|
+
this.logger.info(`realmSpecificEndpointTemplateEnabled set to ${this._realmSpecificEndpointTemplateEnabled}`);
|
|
119
|
+
}
|
|
109
120
|
/**
|
|
110
121
|
* Decrypts data using the given [DecryptDataDetails](https://docs.cloud.oracle.com/api/#/en/key/latest/datatypes/DecryptDataDetails) resource.
|
|
111
122
|
*
|
|
@@ -113,7 +124,7 @@ class KmsCryptoClient {
|
|
|
113
124
|
* @param DecryptRequest
|
|
114
125
|
* @return DecryptResponse
|
|
115
126
|
* @throws OciError when an error occurs
|
|
116
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
127
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/Decrypt.ts.html |here} to see how to use Decrypt API.
|
|
117
128
|
*/
|
|
118
129
|
decrypt(decryptRequest) {
|
|
119
130
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -172,7 +183,7 @@ class KmsCryptoClient {
|
|
|
172
183
|
* @param EncryptRequest
|
|
173
184
|
* @return EncryptResponse
|
|
174
185
|
* @throws OciError when an error occurs
|
|
175
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
186
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/Encrypt.ts.html |here} to see how to use Encrypt API.
|
|
176
187
|
*/
|
|
177
188
|
encrypt(encryptRequest) {
|
|
178
189
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -232,7 +243,7 @@ class KmsCryptoClient {
|
|
|
232
243
|
* @param ExportKeyRequest
|
|
233
244
|
* @return ExportKeyResponse
|
|
234
245
|
* @throws OciError when an error occurs
|
|
235
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
246
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/ExportKey.ts.html |here} to see how to use ExportKey API.
|
|
236
247
|
*/
|
|
237
248
|
exportKey(exportKeyRequest) {
|
|
238
249
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -289,7 +300,7 @@ class KmsCryptoClient {
|
|
|
289
300
|
* @param GenerateDataEncryptionKeyRequest
|
|
290
301
|
* @return GenerateDataEncryptionKeyResponse
|
|
291
302
|
* @throws OciError when an error occurs
|
|
292
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
303
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/GenerateDataEncryptionKey.ts.html |here} to see how to use GenerateDataEncryptionKey API.
|
|
293
304
|
*/
|
|
294
305
|
generateDataEncryptionKey(generateDataEncryptionKeyRequest) {
|
|
295
306
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -349,7 +360,7 @@ class KmsCryptoClient {
|
|
|
349
360
|
* @param SignRequest
|
|
350
361
|
* @return SignResponse
|
|
351
362
|
* @throws OciError when an error occurs
|
|
352
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
363
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/Sign.ts.html |here} to see how to use Sign API.
|
|
353
364
|
*/
|
|
354
365
|
sign(signRequest) {
|
|
355
366
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -409,7 +420,7 @@ class KmsCryptoClient {
|
|
|
409
420
|
* @param VerifyRequest
|
|
410
421
|
* @return VerifyResponse
|
|
411
422
|
* @throws OciError when an error occurs
|
|
412
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
423
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/Verify.ts.html |here} to see how to use Verify API.
|
|
413
424
|
*/
|
|
414
425
|
verify(verifyRequest) {
|
|
415
426
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -472,6 +483,7 @@ var KmsManagementApiKeys;
|
|
|
472
483
|
*/
|
|
473
484
|
class KmsManagementClient {
|
|
474
485
|
constructor(params, clientConfiguration) {
|
|
486
|
+
this["_realmSpecificEndpointTemplateEnabled"] = false;
|
|
475
487
|
this["_endpoint"] = "";
|
|
476
488
|
this["_defaultHeaders"] = {};
|
|
477
489
|
this._circuitBreaker = null;
|
|
@@ -518,6 +530,16 @@ class KmsManagementClient {
|
|
|
518
530
|
get logger() {
|
|
519
531
|
return common.LOG.logger;
|
|
520
532
|
}
|
|
533
|
+
/**
|
|
534
|
+
* Determines whether realm specific endpoint should be used or not.
|
|
535
|
+
* Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
|
|
536
|
+
* @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template
|
|
537
|
+
*/
|
|
538
|
+
set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled) {
|
|
539
|
+
this._realmSpecificEndpointTemplateEnabled = realmSpecificEndpointTemplateEnabled;
|
|
540
|
+
if (this.logger)
|
|
541
|
+
this.logger.info(`realmSpecificEndpointTemplateEnabled set to ${this._realmSpecificEndpointTemplateEnabled}`);
|
|
542
|
+
}
|
|
521
543
|
/**
|
|
522
544
|
* Creates a new KmsManagementWaiter for resources for this service.
|
|
523
545
|
*
|
|
@@ -547,7 +569,7 @@ class KmsManagementClient {
|
|
|
547
569
|
* @param BackupKeyRequest
|
|
548
570
|
* @return BackupKeyResponse
|
|
549
571
|
* @throws OciError when an error occurs
|
|
550
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
572
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/BackupKey.ts.html |here} to see how to use BackupKey API.
|
|
551
573
|
*/
|
|
552
574
|
backupKey(backupKeyRequest) {
|
|
553
575
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -626,7 +648,7 @@ class KmsManagementClient {
|
|
|
626
648
|
* @param CancelKeyDeletionRequest
|
|
627
649
|
* @return CancelKeyDeletionResponse
|
|
628
650
|
* @throws OciError when an error occurs
|
|
629
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
651
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/CancelKeyDeletion.ts.html |here} to see how to use CancelKeyDeletion API.
|
|
630
652
|
*/
|
|
631
653
|
cancelKeyDeletion(cancelKeyDeletionRequest) {
|
|
632
654
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -699,7 +721,7 @@ class KmsManagementClient {
|
|
|
699
721
|
* @param CancelKeyVersionDeletionRequest
|
|
700
722
|
* @return CancelKeyVersionDeletionResponse
|
|
701
723
|
* @throws OciError when an error occurs
|
|
702
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
724
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/CancelKeyVersionDeletion.ts.html |here} to see how to use CancelKeyVersionDeletion API.
|
|
703
725
|
*/
|
|
704
726
|
cancelKeyVersionDeletion(cancelKeyVersionDeletionRequest) {
|
|
705
727
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -774,7 +796,7 @@ class KmsManagementClient {
|
|
|
774
796
|
* @param ChangeKeyCompartmentRequest
|
|
775
797
|
* @return ChangeKeyCompartmentResponse
|
|
776
798
|
* @throws OciError when an error occurs
|
|
777
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
799
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/ChangeKeyCompartment.ts.html |here} to see how to use ChangeKeyCompartment API.
|
|
778
800
|
*/
|
|
779
801
|
changeKeyCompartment(changeKeyCompartmentRequest) {
|
|
780
802
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -842,7 +864,7 @@ class KmsManagementClient {
|
|
|
842
864
|
* @param CreateKeyRequest
|
|
843
865
|
* @return CreateKeyResponse
|
|
844
866
|
* @throws OciError when an error occurs
|
|
845
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
867
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/CreateKey.ts.html |here} to see how to use CreateKey API.
|
|
846
868
|
*/
|
|
847
869
|
createKey(createKeyRequest) {
|
|
848
870
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -912,7 +934,7 @@ class KmsManagementClient {
|
|
|
912
934
|
* @param CreateKeyVersionRequest
|
|
913
935
|
* @return CreateKeyVersionResponse
|
|
914
936
|
* @throws OciError when an error occurs
|
|
915
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
937
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/CreateKeyVersion.ts.html |here} to see how to use CreateKeyVersion API.
|
|
916
938
|
*/
|
|
917
939
|
createKeyVersion(createKeyVersionRequest) {
|
|
918
940
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -983,7 +1005,7 @@ class KmsManagementClient {
|
|
|
983
1005
|
* @param DisableKeyRequest
|
|
984
1006
|
* @return DisableKeyResponse
|
|
985
1007
|
* @throws OciError when an error occurs
|
|
986
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1008
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/DisableKey.ts.html |here} to see how to use DisableKey API.
|
|
987
1009
|
*/
|
|
988
1010
|
disableKey(disableKeyRequest) {
|
|
989
1011
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1055,7 +1077,7 @@ class KmsManagementClient {
|
|
|
1055
1077
|
* @param EnableKeyRequest
|
|
1056
1078
|
* @return EnableKeyResponse
|
|
1057
1079
|
* @throws OciError when an error occurs
|
|
1058
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1080
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/EnableKey.ts.html |here} to see how to use EnableKey API.
|
|
1059
1081
|
*/
|
|
1060
1082
|
enableKey(enableKeyRequest) {
|
|
1061
1083
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1126,7 +1148,7 @@ class KmsManagementClient {
|
|
|
1126
1148
|
* @param GetKeyRequest
|
|
1127
1149
|
* @return GetKeyResponse
|
|
1128
1150
|
* @throws OciError when an error occurs
|
|
1129
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1151
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/GetKey.ts.html |here} to see how to use GetKey API.
|
|
1130
1152
|
*/
|
|
1131
1153
|
getKey(getKeyRequest) {
|
|
1132
1154
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1195,7 +1217,7 @@ class KmsManagementClient {
|
|
|
1195
1217
|
* @param GetKeyVersionRequest
|
|
1196
1218
|
* @return GetKeyVersionResponse
|
|
1197
1219
|
* @throws OciError when an error occurs
|
|
1198
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1220
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/GetKeyVersion.ts.html |here} to see how to use GetKeyVersion API.
|
|
1199
1221
|
*/
|
|
1200
1222
|
getKeyVersion(getKeyVersionRequest) {
|
|
1201
1223
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1263,7 +1285,7 @@ class KmsManagementClient {
|
|
|
1263
1285
|
* @param GetReplicationStatusRequest
|
|
1264
1286
|
* @return GetReplicationStatusResponse
|
|
1265
1287
|
* @throws OciError when an error occurs
|
|
1266
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1288
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/GetReplicationStatus.ts.html |here} to see how to use GetReplicationStatus API.
|
|
1267
1289
|
*/
|
|
1268
1290
|
getReplicationStatus(getReplicationStatusRequest) {
|
|
1269
1291
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1328,7 +1350,7 @@ class KmsManagementClient {
|
|
|
1328
1350
|
* @param GetWrappingKeyRequest
|
|
1329
1351
|
* @return GetWrappingKeyResponse
|
|
1330
1352
|
* @throws OciError when an error occurs
|
|
1331
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1353
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/GetWrappingKey.ts.html |here} to see how to use GetWrappingKey API.
|
|
1332
1354
|
*/
|
|
1333
1355
|
getWrappingKey(getWrappingKeyRequest) {
|
|
1334
1356
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1392,7 +1414,7 @@ class KmsManagementClient {
|
|
|
1392
1414
|
* @param ImportKeyRequest
|
|
1393
1415
|
* @return ImportKeyResponse
|
|
1394
1416
|
* @throws OciError when an error occurs
|
|
1395
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1417
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/ImportKey.ts.html |here} to see how to use ImportKey API.
|
|
1396
1418
|
*/
|
|
1397
1419
|
importKey(importKeyRequest) {
|
|
1398
1420
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1460,7 +1482,7 @@ class KmsManagementClient {
|
|
|
1460
1482
|
* @param ImportKeyVersionRequest
|
|
1461
1483
|
* @return ImportKeyVersionResponse
|
|
1462
1484
|
* @throws OciError when an error occurs
|
|
1463
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1485
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/ImportKeyVersion.ts.html |here} to see how to use ImportKeyVersion API.
|
|
1464
1486
|
*/
|
|
1465
1487
|
importKeyVersion(importKeyVersionRequest) {
|
|
1466
1488
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1532,7 +1554,7 @@ class KmsManagementClient {
|
|
|
1532
1554
|
* @param ListKeyVersionsRequest
|
|
1533
1555
|
* @return ListKeyVersionsResponse
|
|
1534
1556
|
* @throws OciError when an error occurs
|
|
1535
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1557
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/ListKeyVersions.ts.html |here} to see how to use ListKeyVersions API.
|
|
1536
1558
|
*/
|
|
1537
1559
|
listKeyVersions(listKeyVersionsRequest) {
|
|
1538
1560
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1646,7 +1668,7 @@ class KmsManagementClient {
|
|
|
1646
1668
|
* @param ListKeysRequest
|
|
1647
1669
|
* @return ListKeysResponse
|
|
1648
1670
|
* @throws OciError when an error occurs
|
|
1649
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1671
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/ListKeys.ts.html |here} to see how to use ListKeys API.
|
|
1650
1672
|
*/
|
|
1651
1673
|
listKeys(listKeysRequest) {
|
|
1652
1674
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1760,7 +1782,7 @@ class KmsManagementClient {
|
|
|
1760
1782
|
* @param RestoreKeyFromFileRequest
|
|
1761
1783
|
* @return RestoreKeyFromFileResponse
|
|
1762
1784
|
* @throws OciError when an error occurs
|
|
1763
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1785
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/RestoreKeyFromFile.ts.html |here} to see how to use RestoreKeyFromFile API.
|
|
1764
1786
|
*/
|
|
1765
1787
|
restoreKeyFromFile(restoreKeyFromFileRequest) {
|
|
1766
1788
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1839,7 +1861,7 @@ class KmsManagementClient {
|
|
|
1839
1861
|
* @param RestoreKeyFromObjectStoreRequest
|
|
1840
1862
|
* @return RestoreKeyFromObjectStoreResponse
|
|
1841
1863
|
* @throws OciError when an error occurs
|
|
1842
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1864
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/RestoreKeyFromObjectStore.ts.html |here} to see how to use RestoreKeyFromObjectStore API.
|
|
1843
1865
|
*/
|
|
1844
1866
|
restoreKeyFromObjectStore(restoreKeyFromObjectStoreRequest) {
|
|
1845
1867
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1915,7 +1937,7 @@ class KmsManagementClient {
|
|
|
1915
1937
|
* @param ScheduleKeyDeletionRequest
|
|
1916
1938
|
* @return ScheduleKeyDeletionResponse
|
|
1917
1939
|
* @throws OciError when an error occurs
|
|
1918
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1940
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/ScheduleKeyDeletion.ts.html |here} to see how to use ScheduleKeyDeletion API.
|
|
1919
1941
|
*/
|
|
1920
1942
|
scheduleKeyDeletion(scheduleKeyDeletionRequest) {
|
|
1921
1943
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1988,7 +2010,7 @@ class KmsManagementClient {
|
|
|
1988
2010
|
* @param ScheduleKeyVersionDeletionRequest
|
|
1989
2011
|
* @return ScheduleKeyVersionDeletionResponse
|
|
1990
2012
|
* @throws OciError when an error occurs
|
|
1991
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2013
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/ScheduleKeyVersionDeletion.ts.html |here} to see how to use ScheduleKeyVersionDeletion API.
|
|
1992
2014
|
*/
|
|
1993
2015
|
scheduleKeyVersionDeletion(scheduleKeyVersionDeletionRequest) {
|
|
1994
2016
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -2063,7 +2085,7 @@ class KmsManagementClient {
|
|
|
2063
2085
|
* @param UpdateKeyRequest
|
|
2064
2086
|
* @return UpdateKeyResponse
|
|
2065
2087
|
* @throws OciError when an error occurs
|
|
2066
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2088
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/UpdateKey.ts.html |here} to see how to use UpdateKey API.
|
|
2067
2089
|
*/
|
|
2068
2090
|
updateKey(updateKeyRequest) {
|
|
2069
2091
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -2134,11 +2156,14 @@ var KmsVaultApiKeys;
|
|
|
2134
2156
|
*/
|
|
2135
2157
|
class KmsVaultClient {
|
|
2136
2158
|
constructor(params, clientConfiguration) {
|
|
2159
|
+
this["_realmSpecificEndpointTemplateEnabled"] = false;
|
|
2137
2160
|
this["_endpoint"] = "";
|
|
2138
2161
|
this["_defaultHeaders"] = {};
|
|
2139
2162
|
this._circuitBreaker = null;
|
|
2140
2163
|
this._httpOptions = undefined;
|
|
2141
2164
|
this.targetService = "KmsVault";
|
|
2165
|
+
this._regionId = "";
|
|
2166
|
+
this._lastSetRegionOrRegionId = "";
|
|
2142
2167
|
const requestSigner = params.authenticationDetailsProvider
|
|
2143
2168
|
? new common.DefaultRequestSigner(params.authenticationDetailsProvider)
|
|
2144
2169
|
: null;
|
|
@@ -2187,13 +2212,31 @@ class KmsVaultClient {
|
|
|
2187
2212
|
get logger() {
|
|
2188
2213
|
return common.LOG.logger;
|
|
2189
2214
|
}
|
|
2215
|
+
/**
|
|
2216
|
+
* Determines whether realm specific endpoint should be used or not.
|
|
2217
|
+
* Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
|
|
2218
|
+
* @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template
|
|
2219
|
+
*/
|
|
2220
|
+
set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled) {
|
|
2221
|
+
this._realmSpecificEndpointTemplateEnabled = realmSpecificEndpointTemplateEnabled;
|
|
2222
|
+
if (this.logger)
|
|
2223
|
+
this.logger.info(`realmSpecificEndpointTemplateEnabled set to ${this._realmSpecificEndpointTemplateEnabled}`);
|
|
2224
|
+
if (this._lastSetRegionOrRegionId === common.Region.REGION_STRING) {
|
|
2225
|
+
this.endpoint = common.EndpointBuilder.createEndpointFromRegion(KmsVaultClient.serviceEndpointTemplate, this._region, KmsVaultClient.endpointServiceName);
|
|
2226
|
+
}
|
|
2227
|
+
else if (this._lastSetRegionOrRegionId === common.Region.REGION_ID_STRING) {
|
|
2228
|
+
this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(KmsVaultClient.serviceEndpointTemplate, this._regionId, KmsVaultClient.endpointServiceName);
|
|
2229
|
+
}
|
|
2230
|
+
}
|
|
2190
2231
|
/**
|
|
2191
2232
|
* Sets the region to call (ex, Region.US_PHOENIX_1).
|
|
2192
2233
|
* Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
|
|
2193
2234
|
* @param region The region of the service.
|
|
2194
2235
|
*/
|
|
2195
2236
|
set region(region) {
|
|
2237
|
+
this._region = region;
|
|
2196
2238
|
this.endpoint = common.EndpointBuilder.createEndpointFromRegion(KmsVaultClient.serviceEndpointTemplate, region, KmsVaultClient.endpointServiceName);
|
|
2239
|
+
this._lastSetRegionOrRegionId = common.Region.REGION_STRING;
|
|
2197
2240
|
}
|
|
2198
2241
|
/**
|
|
2199
2242
|
* Sets the regionId to call (ex, 'us-phoenix-1').
|
|
@@ -2204,7 +2247,9 @@ class KmsVaultClient {
|
|
|
2204
2247
|
* @param regionId The public region ID.
|
|
2205
2248
|
*/
|
|
2206
2249
|
set regionId(regionId) {
|
|
2250
|
+
this._regionId = regionId;
|
|
2207
2251
|
this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(KmsVaultClient.serviceEndpointTemplate, regionId, KmsVaultClient.endpointServiceName);
|
|
2252
|
+
this._lastSetRegionOrRegionId = common.Region.REGION_ID_STRING;
|
|
2208
2253
|
}
|
|
2209
2254
|
/**
|
|
2210
2255
|
* Creates a new KmsVaultWaiter for resources for this service.
|
|
@@ -2236,7 +2281,7 @@ class KmsVaultClient {
|
|
|
2236
2281
|
* @param BackupVaultRequest
|
|
2237
2282
|
* @return BackupVaultResponse
|
|
2238
2283
|
* @throws OciError when an error occurs
|
|
2239
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2284
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/BackupVault.ts.html |here} to see how to use BackupVault API.
|
|
2240
2285
|
*/
|
|
2241
2286
|
backupVault(backupVaultRequest) {
|
|
2242
2287
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -2316,7 +2361,7 @@ class KmsVaultClient {
|
|
|
2316
2361
|
* @param CancelVaultDeletionRequest
|
|
2317
2362
|
* @return CancelVaultDeletionResponse
|
|
2318
2363
|
* @throws OciError when an error occurs
|
|
2319
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2364
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/CancelVaultDeletion.ts.html |here} to see how to use CancelVaultDeletion API.
|
|
2320
2365
|
*/
|
|
2321
2366
|
cancelVaultDeletion(cancelVaultDeletionRequest) {
|
|
2322
2367
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -2390,7 +2435,7 @@ class KmsVaultClient {
|
|
|
2390
2435
|
* @param ChangeVaultCompartmentRequest
|
|
2391
2436
|
* @return ChangeVaultCompartmentResponse
|
|
2392
2437
|
* @throws OciError when an error occurs
|
|
2393
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2438
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/ChangeVaultCompartment.ts.html |here} to see how to use ChangeVaultCompartment API.
|
|
2394
2439
|
*/
|
|
2395
2440
|
changeVaultCompartment(changeVaultCompartmentRequest) {
|
|
2396
2441
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -2461,7 +2506,7 @@ class KmsVaultClient {
|
|
|
2461
2506
|
* @param CreateVaultRequest
|
|
2462
2507
|
* @return CreateVaultResponse
|
|
2463
2508
|
* @throws OciError when an error occurs
|
|
2464
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2509
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/CreateVault.ts.html |here} to see how to use CreateVault API.
|
|
2465
2510
|
*/
|
|
2466
2511
|
createVault(createVaultRequest) {
|
|
2467
2512
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -2534,7 +2579,7 @@ class KmsVaultClient {
|
|
|
2534
2579
|
* @param CreateVaultReplicaRequest
|
|
2535
2580
|
* @return CreateVaultReplicaResponse
|
|
2536
2581
|
* @throws OciError when an error occurs
|
|
2537
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2582
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/CreateVaultReplica.ts.html |here} to see how to use CreateVaultReplica API.
|
|
2538
2583
|
*/
|
|
2539
2584
|
createVaultReplica(createVaultReplicaRequest) {
|
|
2540
2585
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -2602,7 +2647,7 @@ class KmsVaultClient {
|
|
|
2602
2647
|
* @param DeleteVaultReplicaRequest
|
|
2603
2648
|
* @return DeleteVaultReplicaResponse
|
|
2604
2649
|
* @throws OciError when an error occurs
|
|
2605
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2650
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/DeleteVaultReplica.ts.html |here} to see how to use DeleteVaultReplica API.
|
|
2606
2651
|
*/
|
|
2607
2652
|
deleteVaultReplica(deleteVaultReplicaRequest) {
|
|
2608
2653
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -2670,7 +2715,7 @@ class KmsVaultClient {
|
|
|
2670
2715
|
* @param GetVaultRequest
|
|
2671
2716
|
* @return GetVaultResponse
|
|
2672
2717
|
* @throws OciError when an error occurs
|
|
2673
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2718
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/GetVault.ts.html |here} to see how to use GetVault API.
|
|
2674
2719
|
*/
|
|
2675
2720
|
getVault(getVaultRequest) {
|
|
2676
2721
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -2734,7 +2779,7 @@ class KmsVaultClient {
|
|
|
2734
2779
|
* @param GetVaultUsageRequest
|
|
2735
2780
|
* @return GetVaultUsageResponse
|
|
2736
2781
|
* @throws OciError when an error occurs
|
|
2737
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2782
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/GetVaultUsage.ts.html |here} to see how to use GetVaultUsage API.
|
|
2738
2783
|
*/
|
|
2739
2784
|
getVaultUsage(getVaultUsageRequest) {
|
|
2740
2785
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -2798,7 +2843,7 @@ class KmsVaultClient {
|
|
|
2798
2843
|
* @param ListVaultReplicasRequest
|
|
2799
2844
|
* @return ListVaultReplicasResponse
|
|
2800
2845
|
* @throws OciError when an error occurs
|
|
2801
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2846
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/ListVaultReplicas.ts.html |here} to see how to use ListVaultReplicas API.
|
|
2802
2847
|
*/
|
|
2803
2848
|
listVaultReplicas(listVaultReplicasRequest) {
|
|
2804
2849
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -2919,7 +2964,7 @@ class KmsVaultClient {
|
|
|
2919
2964
|
* @param ListVaultsRequest
|
|
2920
2965
|
* @return ListVaultsResponse
|
|
2921
2966
|
* @throws OciError when an error occurs
|
|
2922
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2967
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/ListVaults.ts.html |here} to see how to use ListVaults API.
|
|
2923
2968
|
*/
|
|
2924
2969
|
listVaults(listVaultsRequest) {
|
|
2925
2970
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -3029,7 +3074,7 @@ class KmsVaultClient {
|
|
|
3029
3074
|
* @param RestoreVaultFromFileRequest
|
|
3030
3075
|
* @return RestoreVaultFromFileResponse
|
|
3031
3076
|
* @throws OciError when an error occurs
|
|
3032
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
3077
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/RestoreVaultFromFile.ts.html |here} to see how to use RestoreVaultFromFile API.
|
|
3033
3078
|
*/
|
|
3034
3079
|
restoreVaultFromFile(restoreVaultFromFileRequest) {
|
|
3035
3080
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -3110,7 +3155,7 @@ class KmsVaultClient {
|
|
|
3110
3155
|
* @param RestoreVaultFromObjectStoreRequest
|
|
3111
3156
|
* @return RestoreVaultFromObjectStoreResponse
|
|
3112
3157
|
* @throws OciError when an error occurs
|
|
3113
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
3158
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/RestoreVaultFromObjectStore.ts.html |here} to see how to use RestoreVaultFromObjectStore API.
|
|
3114
3159
|
*/
|
|
3115
3160
|
restoreVaultFromObjectStore(restoreVaultFromObjectStoreRequest) {
|
|
3116
3161
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -3191,7 +3236,7 @@ class KmsVaultClient {
|
|
|
3191
3236
|
* @param ScheduleVaultDeletionRequest
|
|
3192
3237
|
* @return ScheduleVaultDeletionResponse
|
|
3193
3238
|
* @throws OciError when an error occurs
|
|
3194
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
3239
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/ScheduleVaultDeletion.ts.html |here} to see how to use ScheduleVaultDeletion API.
|
|
3195
3240
|
*/
|
|
3196
3241
|
scheduleVaultDeletion(scheduleVaultDeletionRequest) {
|
|
3197
3242
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -3265,7 +3310,7 @@ class KmsVaultClient {
|
|
|
3265
3310
|
* @param UpdateVaultRequest
|
|
3266
3311
|
* @return UpdateVaultResponse
|
|
3267
3312
|
* @throws OciError when an error occurs
|
|
3268
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
3313
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.59.0/keymanagement/UpdateVault.ts.html |here} to see how to use UpdateVault API.
|
|
3269
3314
|
*/
|
|
3270
3315
|
updateVault(updateVaultRequest) {
|
|
3271
3316
|
return __awaiter(this, void 0, void 0, function* () {
|