oci-keymanagement 2.76.1 → 2.77.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.
Files changed (113) hide show
  1. package/lib/client.d.ts +46 -46
  2. package/lib/client.js +46 -46
  3. package/lib/model/create-ekms-private-endpoint-details.d.ts +2 -2
  4. package/lib/model/create-key-details.d.ts +8 -8
  5. package/lib/model/create-vault-details.d.ts +2 -2
  6. package/lib/model/decrypt-data-details.d.ts +3 -3
  7. package/lib/model/decrypted-data.d.ts +3 -3
  8. package/lib/model/ekms-private-endpoint-summary.d.ts +2 -2
  9. package/lib/model/ekms-private-endpoint.d.ts +2 -2
  10. package/lib/model/encrypt-data-details.d.ts +3 -3
  11. package/lib/model/encrypted-data.d.ts +3 -3
  12. package/lib/model/export-key-details.d.ts +2 -2
  13. package/lib/model/generated-key.d.ts +2 -2
  14. package/lib/model/import-key-details.d.ts +6 -6
  15. package/lib/model/import-key-version-details.d.ts +2 -2
  16. package/lib/model/key-shape.d.ts +1 -1
  17. package/lib/model/key-summary.d.ts +10 -10
  18. package/lib/model/key-version-summary.d.ts +3 -3
  19. package/lib/model/key-version.d.ts +4 -4
  20. package/lib/model/key.d.ts +12 -12
  21. package/lib/model/sign-data-details.d.ts +1 -1
  22. package/lib/model/update-ekms-private-endpoint-details.d.ts +2 -2
  23. package/lib/model/update-key-details.d.ts +2 -2
  24. package/lib/model/update-vault-details.d.ts +2 -2
  25. package/lib/model/vault-summary.d.ts +4 -4
  26. package/lib/model/vault-usage.d.ts +4 -4
  27. package/lib/model/vault.d.ts +5 -5
  28. package/lib/model/verify-data-details.d.ts +1 -1
  29. package/lib/model/wrapped-import-key.d.ts +2 -2
  30. package/lib/model/wrapping-key.d.ts +2 -2
  31. package/lib/request/backup-key-request.d.ts +2 -2
  32. package/lib/request/backup-vault-request.d.ts +2 -2
  33. package/lib/request/cancel-key-deletion-request.d.ts +2 -2
  34. package/lib/request/cancel-key-version-deletion-request.d.ts +2 -2
  35. package/lib/request/cancel-vault-deletion-request.d.ts +2 -2
  36. package/lib/request/change-key-compartment-request.d.ts +2 -2
  37. package/lib/request/change-vault-compartment-request.d.ts +2 -2
  38. package/lib/request/create-ekms-private-endpoint-request.d.ts +1 -1
  39. package/lib/request/create-key-request.d.ts +1 -1
  40. package/lib/request/create-key-version-request.d.ts +1 -1
  41. package/lib/request/create-vault-replica-request.d.ts +2 -2
  42. package/lib/request/create-vault-request.d.ts +1 -1
  43. package/lib/request/decrypt-request.d.ts +1 -1
  44. package/lib/request/delete-ekms-private-endpoint-request.d.ts +2 -2
  45. package/lib/request/delete-vault-replica-request.d.ts +2 -2
  46. package/lib/request/disable-key-request.d.ts +2 -2
  47. package/lib/request/enable-key-request.d.ts +2 -2
  48. package/lib/request/encrypt-request.d.ts +1 -1
  49. package/lib/request/export-key-request.d.ts +1 -1
  50. package/lib/request/generate-data-encryption-key-request.d.ts +1 -1
  51. package/lib/request/get-ekms-private-endpoint-request.d.ts +1 -1
  52. package/lib/request/get-key-request.d.ts +1 -1
  53. package/lib/request/get-key-version-request.d.ts +1 -1
  54. package/lib/request/get-replication-status-request.d.ts +1 -1
  55. package/lib/request/get-vault-request.d.ts +1 -1
  56. package/lib/request/get-vault-usage-request.d.ts +1 -1
  57. package/lib/request/get-wrapping-key-request.d.ts +1 -1
  58. package/lib/request/import-key-request.d.ts +1 -1
  59. package/lib/request/import-key-version-request.d.ts +1 -1
  60. package/lib/request/list-ekms-private-endpoints-request.d.ts +4 -4
  61. package/lib/request/list-key-versions-request.d.ts +4 -4
  62. package/lib/request/list-keys-request.d.ts +9 -9
  63. package/lib/request/list-vault-replicas-request.d.ts +5 -5
  64. package/lib/request/list-vaults-request.d.ts +4 -4
  65. package/lib/request/restore-key-from-file-request.d.ts +2 -2
  66. package/lib/request/restore-key-from-object-store-request.d.ts +2 -2
  67. package/lib/request/restore-vault-from-file-request.d.ts +2 -2
  68. package/lib/request/restore-vault-from-object-store-request.d.ts +2 -2
  69. package/lib/request/schedule-key-deletion-request.d.ts +2 -2
  70. package/lib/request/schedule-key-version-deletion-request.d.ts +2 -2
  71. package/lib/request/schedule-vault-deletion-request.d.ts +2 -2
  72. package/lib/request/sign-request.d.ts +1 -1
  73. package/lib/request/update-ekms-private-endpoint-request.d.ts +2 -2
  74. package/lib/request/update-key-request.d.ts +2 -2
  75. package/lib/request/update-vault-request.d.ts +2 -2
  76. package/lib/request/verify-request.d.ts +1 -1
  77. package/lib/response/backup-key-response.d.ts +1 -1
  78. package/lib/response/backup-vault-response.d.ts +1 -1
  79. package/lib/response/cancel-key-deletion-response.d.ts +1 -1
  80. package/lib/response/cancel-key-version-deletion-response.d.ts +1 -1
  81. package/lib/response/cancel-vault-deletion-response.d.ts +1 -1
  82. package/lib/response/change-key-compartment-response.d.ts +1 -1
  83. package/lib/response/change-vault-compartment-response.d.ts +1 -1
  84. package/lib/response/create-ekms-private-endpoint-response.d.ts +1 -1
  85. package/lib/response/create-key-response.d.ts +1 -1
  86. package/lib/response/create-key-version-response.d.ts +1 -1
  87. package/lib/response/create-vault-response.d.ts +1 -1
  88. package/lib/response/disable-key-response.d.ts +1 -1
  89. package/lib/response/enable-key-response.d.ts +1 -1
  90. package/lib/response/get-ekms-private-endpoint-response.d.ts +1 -1
  91. package/lib/response/get-key-response.d.ts +1 -1
  92. package/lib/response/get-key-version-response.d.ts +1 -1
  93. package/lib/response/get-replication-status-response.d.ts +1 -1
  94. package/lib/response/get-vault-response.d.ts +1 -1
  95. package/lib/response/get-wrapping-key-response.d.ts +1 -1
  96. package/lib/response/import-key-response.d.ts +1 -1
  97. package/lib/response/import-key-version-response.d.ts +1 -1
  98. package/lib/response/list-ekms-private-endpoints-response.d.ts +1 -1
  99. package/lib/response/list-key-versions-response.d.ts +1 -1
  100. package/lib/response/list-keys-response.d.ts +1 -1
  101. package/lib/response/list-vault-replicas-response.d.ts +2 -2
  102. package/lib/response/list-vaults-response.d.ts +1 -1
  103. package/lib/response/restore-key-from-file-response.d.ts +1 -1
  104. package/lib/response/restore-key-from-object-store-response.d.ts +1 -1
  105. package/lib/response/restore-vault-from-file-response.d.ts +1 -1
  106. package/lib/response/restore-vault-from-object-store-response.d.ts +1 -1
  107. package/lib/response/schedule-key-deletion-response.d.ts +1 -1
  108. package/lib/response/schedule-key-version-deletion-response.d.ts +1 -1
  109. package/lib/response/schedule-vault-deletion-response.d.ts +1 -1
  110. package/lib/response/update-ekms-private-endpoint-response.d.ts +1 -1
  111. package/lib/response/update-key-response.d.ts +1 -1
  112. package/lib/response/update-vault-response.d.ts +1 -1
  113. package/package.json +3 -3
package/lib/client.js CHANGED
@@ -190,7 +190,7 @@ class EkmClient {
190
190
  * @param CreateEkmsPrivateEndpointRequest
191
191
  * @return CreateEkmsPrivateEndpointResponse
192
192
  * @throws OciError when an error occurs
193
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/CreateEkmsPrivateEndpoint.ts.html |here} to see how to use CreateEkmsPrivateEndpoint API.
193
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/CreateEkmsPrivateEndpoint.ts.html |here} to see how to use CreateEkmsPrivateEndpoint API.
194
194
  */
195
195
  createEkmsPrivateEndpoint(createEkmsPrivateEndpointRequest) {
196
196
  return __awaiter(this, void 0, void 0, function* () {
@@ -258,7 +258,7 @@ class EkmClient {
258
258
  * @param DeleteEkmsPrivateEndpointRequest
259
259
  * @return DeleteEkmsPrivateEndpointResponse
260
260
  * @throws OciError when an error occurs
261
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/DeleteEkmsPrivateEndpoint.ts.html |here} to see how to use DeleteEkmsPrivateEndpoint API.
261
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/DeleteEkmsPrivateEndpoint.ts.html |here} to see how to use DeleteEkmsPrivateEndpoint API.
262
262
  */
263
263
  deleteEkmsPrivateEndpoint(deleteEkmsPrivateEndpointRequest) {
264
264
  return __awaiter(this, void 0, void 0, function* () {
@@ -318,7 +318,7 @@ class EkmClient {
318
318
  * @param GetEkmsPrivateEndpointRequest
319
319
  * @return GetEkmsPrivateEndpointResponse
320
320
  * @throws OciError when an error occurs
321
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/GetEkmsPrivateEndpoint.ts.html |here} to see how to use GetEkmsPrivateEndpoint API.
321
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/GetEkmsPrivateEndpoint.ts.html |here} to see how to use GetEkmsPrivateEndpoint API.
322
322
  */
323
323
  getEkmsPrivateEndpoint(getEkmsPrivateEndpointRequest) {
324
324
  return __awaiter(this, void 0, void 0, function* () {
@@ -382,7 +382,7 @@ class EkmClient {
382
382
  * @param ListEkmsPrivateEndpointsRequest
383
383
  * @return ListEkmsPrivateEndpointsResponse
384
384
  * @throws OciError when an error occurs
385
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/ListEkmsPrivateEndpoints.ts.html |here} to see how to use ListEkmsPrivateEndpoints API.
385
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/ListEkmsPrivateEndpoints.ts.html |here} to see how to use ListEkmsPrivateEndpoints API.
386
386
  */
387
387
  listEkmsPrivateEndpoints(listEkmsPrivateEndpointsRequest) {
388
388
  return __awaiter(this, void 0, void 0, function* () {
@@ -489,7 +489,7 @@ class EkmClient {
489
489
  * @param UpdateEkmsPrivateEndpointRequest
490
490
  * @return UpdateEkmsPrivateEndpointResponse
491
491
  * @throws OciError when an error occurs
492
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/UpdateEkmsPrivateEndpoint.ts.html |here} to see how to use UpdateEkmsPrivateEndpoint API.
492
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/UpdateEkmsPrivateEndpoint.ts.html |here} to see how to use UpdateEkmsPrivateEndpoint API.
493
493
  */
494
494
  updateEkmsPrivateEndpoint(updateEkmsPrivateEndpointRequest) {
495
495
  return __awaiter(this, void 0, void 0, function* () {
@@ -632,7 +632,7 @@ class KmsCryptoClient {
632
632
  * @param DecryptRequest
633
633
  * @return DecryptResponse
634
634
  * @throws OciError when an error occurs
635
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/Decrypt.ts.html |here} to see how to use Decrypt API.
635
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/Decrypt.ts.html |here} to see how to use Decrypt API.
636
636
  */
637
637
  decrypt(decryptRequest) {
638
638
  return __awaiter(this, void 0, void 0, function* () {
@@ -691,7 +691,7 @@ class KmsCryptoClient {
691
691
  * @param EncryptRequest
692
692
  * @return EncryptResponse
693
693
  * @throws OciError when an error occurs
694
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/Encrypt.ts.html |here} to see how to use Encrypt API.
694
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/Encrypt.ts.html |here} to see how to use Encrypt API.
695
695
  */
696
696
  encrypt(encryptRequest) {
697
697
  return __awaiter(this, void 0, void 0, function* () {
@@ -752,7 +752,7 @@ class KmsCryptoClient {
752
752
  * @param ExportKeyRequest
753
753
  * @return ExportKeyResponse
754
754
  * @throws OciError when an error occurs
755
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/ExportKey.ts.html |here} to see how to use ExportKey API.
755
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/ExportKey.ts.html |here} to see how to use ExportKey API.
756
756
  */
757
757
  exportKey(exportKeyRequest) {
758
758
  return __awaiter(this, void 0, void 0, function* () {
@@ -809,7 +809,7 @@ class KmsCryptoClient {
809
809
  * @param GenerateDataEncryptionKeyRequest
810
810
  * @return GenerateDataEncryptionKeyResponse
811
811
  * @throws OciError when an error occurs
812
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/GenerateDataEncryptionKey.ts.html |here} to see how to use GenerateDataEncryptionKey API.
812
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/GenerateDataEncryptionKey.ts.html |here} to see how to use GenerateDataEncryptionKey API.
813
813
  */
814
814
  generateDataEncryptionKey(generateDataEncryptionKeyRequest) {
815
815
  return __awaiter(this, void 0, void 0, function* () {
@@ -870,7 +870,7 @@ class KmsCryptoClient {
870
870
  * @param SignRequest
871
871
  * @return SignResponse
872
872
  * @throws OciError when an error occurs
873
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/Sign.ts.html |here} to see how to use Sign API.
873
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/Sign.ts.html |here} to see how to use Sign API.
874
874
  */
875
875
  sign(signRequest) {
876
876
  return __awaiter(this, void 0, void 0, function* () {
@@ -931,7 +931,7 @@ class KmsCryptoClient {
931
931
  * @param VerifyRequest
932
932
  * @return VerifyResponse
933
933
  * @throws OciError when an error occurs
934
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/Verify.ts.html |here} to see how to use Verify API.
934
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/Verify.ts.html |here} to see how to use Verify API.
935
935
  */
936
936
  verify(verifyRequest) {
937
937
  return __awaiter(this, void 0, void 0, function* () {
@@ -1088,7 +1088,7 @@ class KmsManagementClient {
1088
1088
  * @param BackupKeyRequest
1089
1089
  * @return BackupKeyResponse
1090
1090
  * @throws OciError when an error occurs
1091
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/BackupKey.ts.html |here} to see how to use BackupKey API.
1091
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/BackupKey.ts.html |here} to see how to use BackupKey API.
1092
1092
  */
1093
1093
  backupKey(backupKeyRequest) {
1094
1094
  return __awaiter(this, void 0, void 0, function* () {
@@ -1167,7 +1167,7 @@ class KmsManagementClient {
1167
1167
  * @param CancelKeyDeletionRequest
1168
1168
  * @return CancelKeyDeletionResponse
1169
1169
  * @throws OciError when an error occurs
1170
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/CancelKeyDeletion.ts.html |here} to see how to use CancelKeyDeletion API.
1170
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/CancelKeyDeletion.ts.html |here} to see how to use CancelKeyDeletion API.
1171
1171
  */
1172
1172
  cancelKeyDeletion(cancelKeyDeletionRequest) {
1173
1173
  return __awaiter(this, void 0, void 0, function* () {
@@ -1240,7 +1240,7 @@ class KmsManagementClient {
1240
1240
  * @param CancelKeyVersionDeletionRequest
1241
1241
  * @return CancelKeyVersionDeletionResponse
1242
1242
  * @throws OciError when an error occurs
1243
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/CancelKeyVersionDeletion.ts.html |here} to see how to use CancelKeyVersionDeletion API.
1243
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/CancelKeyVersionDeletion.ts.html |here} to see how to use CancelKeyVersionDeletion API.
1244
1244
  */
1245
1245
  cancelKeyVersionDeletion(cancelKeyVersionDeletionRequest) {
1246
1246
  return __awaiter(this, void 0, void 0, function* () {
@@ -1315,7 +1315,7 @@ class KmsManagementClient {
1315
1315
  * @param ChangeKeyCompartmentRequest
1316
1316
  * @return ChangeKeyCompartmentResponse
1317
1317
  * @throws OciError when an error occurs
1318
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/ChangeKeyCompartment.ts.html |here} to see how to use ChangeKeyCompartment API.
1318
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/ChangeKeyCompartment.ts.html |here} to see how to use ChangeKeyCompartment API.
1319
1319
  */
1320
1320
  changeKeyCompartment(changeKeyCompartmentRequest) {
1321
1321
  return __awaiter(this, void 0, void 0, function* () {
@@ -1383,7 +1383,7 @@ class KmsManagementClient {
1383
1383
  * @param CreateKeyRequest
1384
1384
  * @return CreateKeyResponse
1385
1385
  * @throws OciError when an error occurs
1386
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/CreateKey.ts.html |here} to see how to use CreateKey API.
1386
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/CreateKey.ts.html |here} to see how to use CreateKey API.
1387
1387
  */
1388
1388
  createKey(createKeyRequest) {
1389
1389
  return __awaiter(this, void 0, void 0, function* () {
@@ -1453,7 +1453,7 @@ class KmsManagementClient {
1453
1453
  * @param CreateKeyVersionRequest
1454
1454
  * @return CreateKeyVersionResponse
1455
1455
  * @throws OciError when an error occurs
1456
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/CreateKeyVersion.ts.html |here} to see how to use CreateKeyVersion API.
1456
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/CreateKeyVersion.ts.html |here} to see how to use CreateKeyVersion API.
1457
1457
  */
1458
1458
  createKeyVersion(createKeyVersionRequest) {
1459
1459
  return __awaiter(this, void 0, void 0, function* () {
@@ -1525,7 +1525,7 @@ class KmsManagementClient {
1525
1525
  * @param DisableKeyRequest
1526
1526
  * @return DisableKeyResponse
1527
1527
  * @throws OciError when an error occurs
1528
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/DisableKey.ts.html |here} to see how to use DisableKey API.
1528
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/DisableKey.ts.html |here} to see how to use DisableKey API.
1529
1529
  */
1530
1530
  disableKey(disableKeyRequest) {
1531
1531
  return __awaiter(this, void 0, void 0, function* () {
@@ -1597,7 +1597,7 @@ class KmsManagementClient {
1597
1597
  * @param EnableKeyRequest
1598
1598
  * @return EnableKeyResponse
1599
1599
  * @throws OciError when an error occurs
1600
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/EnableKey.ts.html |here} to see how to use EnableKey API.
1600
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/EnableKey.ts.html |here} to see how to use EnableKey API.
1601
1601
  */
1602
1602
  enableKey(enableKeyRequest) {
1603
1603
  return __awaiter(this, void 0, void 0, function* () {
@@ -1668,7 +1668,7 @@ class KmsManagementClient {
1668
1668
  * @param GetKeyRequest
1669
1669
  * @return GetKeyResponse
1670
1670
  * @throws OciError when an error occurs
1671
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/GetKey.ts.html |here} to see how to use GetKey API.
1671
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/GetKey.ts.html |here} to see how to use GetKey API.
1672
1672
  */
1673
1673
  getKey(getKeyRequest) {
1674
1674
  return __awaiter(this, void 0, void 0, function* () {
@@ -1737,7 +1737,7 @@ class KmsManagementClient {
1737
1737
  * @param GetKeyVersionRequest
1738
1738
  * @return GetKeyVersionResponse
1739
1739
  * @throws OciError when an error occurs
1740
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/GetKeyVersion.ts.html |here} to see how to use GetKeyVersion API.
1740
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/GetKeyVersion.ts.html |here} to see how to use GetKeyVersion API.
1741
1741
  */
1742
1742
  getKeyVersion(getKeyVersionRequest) {
1743
1743
  return __awaiter(this, void 0, void 0, function* () {
@@ -1805,7 +1805,7 @@ class KmsManagementClient {
1805
1805
  * @param GetReplicationStatusRequest
1806
1806
  * @return GetReplicationStatusResponse
1807
1807
  * @throws OciError when an error occurs
1808
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/GetReplicationStatus.ts.html |here} to see how to use GetReplicationStatus API.
1808
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/GetReplicationStatus.ts.html |here} to see how to use GetReplicationStatus API.
1809
1809
  */
1810
1810
  getReplicationStatus(getReplicationStatusRequest) {
1811
1811
  return __awaiter(this, void 0, void 0, function* () {
@@ -1870,7 +1870,7 @@ class KmsManagementClient {
1870
1870
  * @param GetWrappingKeyRequest
1871
1871
  * @return GetWrappingKeyResponse
1872
1872
  * @throws OciError when an error occurs
1873
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/GetWrappingKey.ts.html |here} to see how to use GetWrappingKey API.
1873
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/GetWrappingKey.ts.html |here} to see how to use GetWrappingKey API.
1874
1874
  */
1875
1875
  getWrappingKey(getWrappingKeyRequest) {
1876
1876
  return __awaiter(this, void 0, void 0, function* () {
@@ -1937,7 +1937,7 @@ class KmsManagementClient {
1937
1937
  * @param ImportKeyRequest
1938
1938
  * @return ImportKeyResponse
1939
1939
  * @throws OciError when an error occurs
1940
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/ImportKey.ts.html |here} to see how to use ImportKey API.
1940
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/ImportKey.ts.html |here} to see how to use ImportKey API.
1941
1941
  */
1942
1942
  importKey(importKeyRequest) {
1943
1943
  return __awaiter(this, void 0, void 0, function* () {
@@ -2006,7 +2006,7 @@ class KmsManagementClient {
2006
2006
  * @param ImportKeyVersionRequest
2007
2007
  * @return ImportKeyVersionResponse
2008
2008
  * @throws OciError when an error occurs
2009
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/ImportKeyVersion.ts.html |here} to see how to use ImportKeyVersion API.
2009
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/ImportKeyVersion.ts.html |here} to see how to use ImportKeyVersion API.
2010
2010
  */
2011
2011
  importKeyVersion(importKeyVersionRequest) {
2012
2012
  return __awaiter(this, void 0, void 0, function* () {
@@ -2078,7 +2078,7 @@ class KmsManagementClient {
2078
2078
  * @param ListKeyVersionsRequest
2079
2079
  * @return ListKeyVersionsResponse
2080
2080
  * @throws OciError when an error occurs
2081
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/ListKeyVersions.ts.html |here} to see how to use ListKeyVersions API.
2081
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/ListKeyVersions.ts.html |here} to see how to use ListKeyVersions API.
2082
2082
  */
2083
2083
  listKeyVersions(listKeyVersionsRequest) {
2084
2084
  return __awaiter(this, void 0, void 0, function* () {
@@ -2192,7 +2192,7 @@ class KmsManagementClient {
2192
2192
  * @param ListKeysRequest
2193
2193
  * @return ListKeysResponse
2194
2194
  * @throws OciError when an error occurs
2195
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/ListKeys.ts.html |here} to see how to use ListKeys API.
2195
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/ListKeys.ts.html |here} to see how to use ListKeys API.
2196
2196
  */
2197
2197
  listKeys(listKeysRequest) {
2198
2198
  return __awaiter(this, void 0, void 0, function* () {
@@ -2306,7 +2306,7 @@ class KmsManagementClient {
2306
2306
  * @param RestoreKeyFromFileRequest
2307
2307
  * @return RestoreKeyFromFileResponse
2308
2308
  * @throws OciError when an error occurs
2309
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/RestoreKeyFromFile.ts.html |here} to see how to use RestoreKeyFromFile API.
2309
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/RestoreKeyFromFile.ts.html |here} to see how to use RestoreKeyFromFile API.
2310
2310
  */
2311
2311
  restoreKeyFromFile(restoreKeyFromFileRequest) {
2312
2312
  return __awaiter(this, void 0, void 0, function* () {
@@ -2385,7 +2385,7 @@ class KmsManagementClient {
2385
2385
  * @param RestoreKeyFromObjectStoreRequest
2386
2386
  * @return RestoreKeyFromObjectStoreResponse
2387
2387
  * @throws OciError when an error occurs
2388
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/RestoreKeyFromObjectStore.ts.html |here} to see how to use RestoreKeyFromObjectStore API.
2388
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/RestoreKeyFromObjectStore.ts.html |here} to see how to use RestoreKeyFromObjectStore API.
2389
2389
  */
2390
2390
  restoreKeyFromObjectStore(restoreKeyFromObjectStoreRequest) {
2391
2391
  return __awaiter(this, void 0, void 0, function* () {
@@ -2461,7 +2461,7 @@ class KmsManagementClient {
2461
2461
  * @param ScheduleKeyDeletionRequest
2462
2462
  * @return ScheduleKeyDeletionResponse
2463
2463
  * @throws OciError when an error occurs
2464
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/ScheduleKeyDeletion.ts.html |here} to see how to use ScheduleKeyDeletion API.
2464
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/ScheduleKeyDeletion.ts.html |here} to see how to use ScheduleKeyDeletion API.
2465
2465
  */
2466
2466
  scheduleKeyDeletion(scheduleKeyDeletionRequest) {
2467
2467
  return __awaiter(this, void 0, void 0, function* () {
@@ -2534,7 +2534,7 @@ class KmsManagementClient {
2534
2534
  * @param ScheduleKeyVersionDeletionRequest
2535
2535
  * @return ScheduleKeyVersionDeletionResponse
2536
2536
  * @throws OciError when an error occurs
2537
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/ScheduleKeyVersionDeletion.ts.html |here} to see how to use ScheduleKeyVersionDeletion API.
2537
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/ScheduleKeyVersionDeletion.ts.html |here} to see how to use ScheduleKeyVersionDeletion API.
2538
2538
  */
2539
2539
  scheduleKeyVersionDeletion(scheduleKeyVersionDeletionRequest) {
2540
2540
  return __awaiter(this, void 0, void 0, function* () {
@@ -2609,7 +2609,7 @@ class KmsManagementClient {
2609
2609
  * @param UpdateKeyRequest
2610
2610
  * @return UpdateKeyResponse
2611
2611
  * @throws OciError when an error occurs
2612
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/UpdateKey.ts.html |here} to see how to use UpdateKey API.
2612
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/UpdateKey.ts.html |here} to see how to use UpdateKey API.
2613
2613
  */
2614
2614
  updateKey(updateKeyRequest) {
2615
2615
  return __awaiter(this, void 0, void 0, function* () {
@@ -2813,7 +2813,7 @@ class KmsVaultClient {
2813
2813
  * @param BackupVaultRequest
2814
2814
  * @return BackupVaultResponse
2815
2815
  * @throws OciError when an error occurs
2816
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/BackupVault.ts.html |here} to see how to use BackupVault API.
2816
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/BackupVault.ts.html |here} to see how to use BackupVault API.
2817
2817
  */
2818
2818
  backupVault(backupVaultRequest) {
2819
2819
  return __awaiter(this, void 0, void 0, function* () {
@@ -2893,7 +2893,7 @@ class KmsVaultClient {
2893
2893
  * @param CancelVaultDeletionRequest
2894
2894
  * @return CancelVaultDeletionResponse
2895
2895
  * @throws OciError when an error occurs
2896
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/CancelVaultDeletion.ts.html |here} to see how to use CancelVaultDeletion API.
2896
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/CancelVaultDeletion.ts.html |here} to see how to use CancelVaultDeletion API.
2897
2897
  */
2898
2898
  cancelVaultDeletion(cancelVaultDeletionRequest) {
2899
2899
  return __awaiter(this, void 0, void 0, function* () {
@@ -2967,7 +2967,7 @@ class KmsVaultClient {
2967
2967
  * @param ChangeVaultCompartmentRequest
2968
2968
  * @return ChangeVaultCompartmentResponse
2969
2969
  * @throws OciError when an error occurs
2970
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/ChangeVaultCompartment.ts.html |here} to see how to use ChangeVaultCompartment API.
2970
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/ChangeVaultCompartment.ts.html |here} to see how to use ChangeVaultCompartment API.
2971
2971
  */
2972
2972
  changeVaultCompartment(changeVaultCompartmentRequest) {
2973
2973
  return __awaiter(this, void 0, void 0, function* () {
@@ -3038,7 +3038,7 @@ class KmsVaultClient {
3038
3038
  * @param CreateVaultRequest
3039
3039
  * @return CreateVaultResponse
3040
3040
  * @throws OciError when an error occurs
3041
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/CreateVault.ts.html |here} to see how to use CreateVault API.
3041
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/CreateVault.ts.html |here} to see how to use CreateVault API.
3042
3042
  */
3043
3043
  createVault(createVaultRequest) {
3044
3044
  return __awaiter(this, void 0, void 0, function* () {
@@ -3111,7 +3111,7 @@ class KmsVaultClient {
3111
3111
  * @param CreateVaultReplicaRequest
3112
3112
  * @return CreateVaultReplicaResponse
3113
3113
  * @throws OciError when an error occurs
3114
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/CreateVaultReplica.ts.html |here} to see how to use CreateVaultReplica API.
3114
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/CreateVaultReplica.ts.html |here} to see how to use CreateVaultReplica API.
3115
3115
  */
3116
3116
  createVaultReplica(createVaultReplicaRequest) {
3117
3117
  return __awaiter(this, void 0, void 0, function* () {
@@ -3179,7 +3179,7 @@ class KmsVaultClient {
3179
3179
  * @param DeleteVaultReplicaRequest
3180
3180
  * @return DeleteVaultReplicaResponse
3181
3181
  * @throws OciError when an error occurs
3182
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/DeleteVaultReplica.ts.html |here} to see how to use DeleteVaultReplica API.
3182
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/DeleteVaultReplica.ts.html |here} to see how to use DeleteVaultReplica API.
3183
3183
  */
3184
3184
  deleteVaultReplica(deleteVaultReplicaRequest) {
3185
3185
  return __awaiter(this, void 0, void 0, function* () {
@@ -3247,7 +3247,7 @@ class KmsVaultClient {
3247
3247
  * @param GetVaultRequest
3248
3248
  * @return GetVaultResponse
3249
3249
  * @throws OciError when an error occurs
3250
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/GetVault.ts.html |here} to see how to use GetVault API.
3250
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/GetVault.ts.html |here} to see how to use GetVault API.
3251
3251
  */
3252
3252
  getVault(getVaultRequest) {
3253
3253
  return __awaiter(this, void 0, void 0, function* () {
@@ -3311,7 +3311,7 @@ class KmsVaultClient {
3311
3311
  * @param GetVaultUsageRequest
3312
3312
  * @return GetVaultUsageResponse
3313
3313
  * @throws OciError when an error occurs
3314
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/GetVaultUsage.ts.html |here} to see how to use GetVaultUsage API.
3314
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/GetVaultUsage.ts.html |here} to see how to use GetVaultUsage API.
3315
3315
  */
3316
3316
  getVaultUsage(getVaultUsageRequest) {
3317
3317
  return __awaiter(this, void 0, void 0, function* () {
@@ -3375,7 +3375,7 @@ class KmsVaultClient {
3375
3375
  * @param ListVaultReplicasRequest
3376
3376
  * @return ListVaultReplicasResponse
3377
3377
  * @throws OciError when an error occurs
3378
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/ListVaultReplicas.ts.html |here} to see how to use ListVaultReplicas API.
3378
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/ListVaultReplicas.ts.html |here} to see how to use ListVaultReplicas API.
3379
3379
  */
3380
3380
  listVaultReplicas(listVaultReplicasRequest) {
3381
3381
  return __awaiter(this, void 0, void 0, function* () {
@@ -3496,7 +3496,7 @@ class KmsVaultClient {
3496
3496
  * @param ListVaultsRequest
3497
3497
  * @return ListVaultsResponse
3498
3498
  * @throws OciError when an error occurs
3499
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/ListVaults.ts.html |here} to see how to use ListVaults API.
3499
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/ListVaults.ts.html |here} to see how to use ListVaults API.
3500
3500
  */
3501
3501
  listVaults(listVaultsRequest) {
3502
3502
  return __awaiter(this, void 0, void 0, function* () {
@@ -3606,7 +3606,7 @@ class KmsVaultClient {
3606
3606
  * @param RestoreVaultFromFileRequest
3607
3607
  * @return RestoreVaultFromFileResponse
3608
3608
  * @throws OciError when an error occurs
3609
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/RestoreVaultFromFile.ts.html |here} to see how to use RestoreVaultFromFile API.
3609
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/RestoreVaultFromFile.ts.html |here} to see how to use RestoreVaultFromFile API.
3610
3610
  */
3611
3611
  restoreVaultFromFile(restoreVaultFromFileRequest) {
3612
3612
  return __awaiter(this, void 0, void 0, function* () {
@@ -3687,7 +3687,7 @@ class KmsVaultClient {
3687
3687
  * @param RestoreVaultFromObjectStoreRequest
3688
3688
  * @return RestoreVaultFromObjectStoreResponse
3689
3689
  * @throws OciError when an error occurs
3690
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/RestoreVaultFromObjectStore.ts.html |here} to see how to use RestoreVaultFromObjectStore API.
3690
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/RestoreVaultFromObjectStore.ts.html |here} to see how to use RestoreVaultFromObjectStore API.
3691
3691
  */
3692
3692
  restoreVaultFromObjectStore(restoreVaultFromObjectStoreRequest) {
3693
3693
  return __awaiter(this, void 0, void 0, function* () {
@@ -3768,7 +3768,7 @@ class KmsVaultClient {
3768
3768
  * @param ScheduleVaultDeletionRequest
3769
3769
  * @return ScheduleVaultDeletionResponse
3770
3770
  * @throws OciError when an error occurs
3771
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/ScheduleVaultDeletion.ts.html |here} to see how to use ScheduleVaultDeletion API.
3771
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/ScheduleVaultDeletion.ts.html |here} to see how to use ScheduleVaultDeletion API.
3772
3772
  */
3773
3773
  scheduleVaultDeletion(scheduleVaultDeletionRequest) {
3774
3774
  return __awaiter(this, void 0, void 0, function* () {
@@ -3842,7 +3842,7 @@ class KmsVaultClient {
3842
3842
  * @param UpdateVaultRequest
3843
3843
  * @return UpdateVaultResponse
3844
3844
  * @throws OciError when an error occurs
3845
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/keymanagement/UpdateVault.ts.html |here} to see how to use UpdateVault API.
3845
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/keymanagement/UpdateVault.ts.html |here} to see how to use UpdateVault API.
3846
3846
  */
3847
3847
  updateVault(updateVaultRequest) {
3848
3848
  return __awaiter(this, void 0, void 0, function* () {
@@ -26,7 +26,7 @@ export interface CreateEkmsPrivateEndpointDetails {
26
26
  "compartmentId": string;
27
27
  /**
28
28
  * Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
29
- * Example: `{\"bar-key\": \"value\"}`
29
+ * Example: {@code {\"bar-key\": \"value\"}}
30
30
  *
31
31
  */
32
32
  "freeformTags"?: {
@@ -34,7 +34,7 @@ export interface CreateEkmsPrivateEndpointDetails {
34
34
  };
35
35
  /**
36
36
  * Usage of predefined tag keys. These predefined keys are scoped to namespaces.
37
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
37
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
38
38
  *
39
39
  */
40
40
  "definedTags"?: {
@@ -23,7 +23,7 @@ export interface CreateKeyDetails {
23
23
  /**
24
24
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
25
25
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
26
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
26
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
27
27
  *
28
28
  */
29
29
  "definedTags"?: {
@@ -40,7 +40,7 @@ export interface CreateKeyDetails {
40
40
  /**
41
41
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
42
42
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
43
- * Example: `{\"Department\": \"Finance\"}`
43
+ * Example: {@code {\"Department\": \"Finance\"}}
44
44
  *
45
45
  */
46
46
  "freeformTags"?: {
@@ -49,13 +49,13 @@ export interface CreateKeyDetails {
49
49
  "keyShape": model.KeyShape;
50
50
  /**
51
51
  * The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
52
- * A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside
53
- * the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists
54
- * on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. By default,
55
- * a key's protection mode is set to `HSM`. You can't change a key's protection mode after the key is created or imported.
56
- * A protection mode of `EXTERNAL` mean that the key persists on the customer's external key manager which is hosted externally outside of oracle.
52
+ * A protection mode of {@code HSM} means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside
53
+ * the HSM. A protection mode of {@code SOFTWARE} means that the key persists on the server, protected by the vault's RSA wrapping key which persists
54
+ * on the HSM. All cryptographic operations that use a key with a protection mode of {@code SOFTWARE} are performed on the server. By default,
55
+ * a key's protection mode is set to {@code HSM}. You can't change a key's protection mode after the key is created or imported.
56
+ * A protection mode of {@code EXTERNAL} mean that the key persists on the customer's external key manager which is hosted externally outside of oracle.
57
57
  * Oracle only hold a reference to that key.
58
- * All cryptographic operations that use a key with a protection mode of `EXTERNAL` are performed by external key manager.
58
+ * All cryptographic operations that use a key with a protection mode of {@code EXTERNAL} are performed by external key manager.
59
59
  *
60
60
  */
61
61
  "protectionMode"?: CreateKeyDetails.ProtectionMode;
@@ -23,7 +23,7 @@ export interface CreateVaultDetails {
23
23
  /**
24
24
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
25
25
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
26
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
26
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
27
27
  *
28
28
  */
29
29
  "definedTags"?: {
@@ -40,7 +40,7 @@ export interface CreateVaultDetails {
40
40
  /**
41
41
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
42
42
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
43
- * Example: `{\"Department\": \"Finance\"}`
43
+ * Example: {@code {\"Department\": \"Finance\"}}
44
44
  *
45
45
  */
46
46
  "freeformTags"?: {
@@ -45,10 +45,10 @@ export interface DecryptDataDetails {
45
45
  "keyVersionId"?: string;
46
46
  /**
47
47
  * The encryption algorithm to use to encrypt or decrypt data with a customer-managed key.
48
- * `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and
49
- * that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the
48
+ * {@code AES_256_GCM} indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and
49
+ * that the mode of encryption is the Galois/Counter Mode (GCM). {@code RSA_OAEP_SHA_1} indicates that the
50
50
  * key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).
51
- * `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash
51
+ * {@code RSA_OAEP_SHA_256} indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash
52
52
  * and uses OAEP.
53
53
  *
54
54
  */
@@ -33,10 +33,10 @@ export interface DecryptedData {
33
33
  "keyVersionId"?: string;
34
34
  /**
35
35
  * The encryption algorithm to use to encrypt and decrypt data with a customer-managed key
36
- * `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and
37
- * that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the
36
+ * {@code AES_256_GCM} indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and
37
+ * that the mode of encryption is the Galois/Counter Mode (GCM). {@code RSA_OAEP_SHA_1} indicates that the
38
38
  * key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).
39
- * `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash
39
+ * {@code RSA_OAEP_SHA_256} indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash
40
40
  * and uses OAEP.
41
41
  *
42
42
  */
@@ -41,7 +41,7 @@ export interface EkmsPrivateEndpointSummary {
41
41
  "displayName": string;
42
42
  /**
43
43
  * Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
44
- * Example: `{\"bar-key\": \"value\"}`
44
+ * Example: {@code {\"bar-key\": \"value\"}}
45
45
  *
46
46
  */
47
47
  "freeformTags"?: {
@@ -49,7 +49,7 @@ export interface EkmsPrivateEndpointSummary {
49
49
  };
50
50
  /**
51
51
  * Usage of predefined tag keys. These predefined keys are scoped to namespaces.
52
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
52
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
53
53
  *
54
54
  */
55
55
  "definedTags"?: {
@@ -41,7 +41,7 @@ export interface EkmsPrivateEndpoint {
41
41
  "timeUpdated"?: Date;
42
42
  /**
43
43
  * Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
44
- * Example: `{\"bar-key\": \"value\"}`
44
+ * Example: {@code {\"bar-key\": \"value\"}}
45
45
  *
46
46
  */
47
47
  "freeformTags"?: {
@@ -49,7 +49,7 @@ export interface EkmsPrivateEndpoint {
49
49
  };
50
50
  /**
51
51
  * Usage of predefined tag keys. These predefined keys are scoped to namespaces.
52
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
52
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
53
53
  *
54
54
  */
55
55
  "definedTags"?: {
@@ -46,10 +46,10 @@ export interface EncryptDataDetails {
46
46
  "keyVersionId"?: string;
47
47
  /**
48
48
  * The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
49
- * `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and
50
- * that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the
49
+ * {@code AES_256_GCM} indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and
50
+ * that the mode of encryption is the Galois/Counter Mode (GCM). {@code RSA_OAEP_SHA_1} indicates that the
51
51
  * key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).
52
- * `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash
52
+ * {@code RSA_OAEP_SHA_256} indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash
53
53
  * and uses OAEP.
54
54
  *
55
55
  */
@@ -29,10 +29,10 @@ export interface EncryptedData {
29
29
  "keyVersionId"?: string;
30
30
  /**
31
31
  * The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
32
- * `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and
33
- * that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the
32
+ * {@code AES_256_GCM} indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and
33
+ * that the mode of encryption is the Galois/Counter Mode (GCM). {@code RSA_OAEP_SHA_1} indicates that the
34
34
  * key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).
35
- * `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash
35
+ * {@code RSA_OAEP_SHA_256} indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash
36
36
  * and uses OAEP.
37
37
  *
38
38
  */
@@ -25,11 +25,11 @@ export interface ExportKeyDetails {
25
25
  */
26
26
  "keyVersionId"?: string;
27
27
  /**
28
- * The encryption algorithm to use to encrypt exportable key material from a software-backed key. Specifying `RSA_OAEP_AES_SHA256`
28
+ * The encryption algorithm to use to encrypt exportable key material from a software-backed key. Specifying {@code RSA_OAEP_AES_SHA256}
29
29
  * invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped by the RSA public
30
30
  * wrapping key provided along with the request, creating a wrapped temporary AES key. The temporary AES key is also used to wrap
31
31
  * the exportable key material. The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing
32
- * concatenated blob output that jointly represents them. Specifying `RSA_OAEP_SHA256` means that the software key is wrapped by
32
+ * concatenated blob output that jointly represents them. Specifying {@code RSA_OAEP_SHA256} means that the software key is wrapped by
33
33
  * the RSA public wrapping key provided along with the request.
34
34
  *
35
35
  */
@@ -22,14 +22,14 @@ export interface GeneratedKey {
22
22
  /**
23
23
  * The plaintext data encryption key, a base64-encoded sequence of random bytes, which is
24
24
  * included if the [GenerateDataEncryptionKey](https://docs.cloud.oracle.com/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey)
25
- * request includes the `includePlaintextKey` parameter and sets its value to \"true\".
25
+ * request includes the {@code includePlaintextKey} parameter and sets its value to \"true\".
26
26
  *
27
27
  */
28
28
  "plaintext"?: string;
29
29
  /**
30
30
  * The checksum of the plaintext data encryption key, which is included if the
31
31
  * [GenerateDataEncryptionKey](https://docs.cloud.oracle.com/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey)
32
- * request includes the `includePlaintextKey` parameter and sets its value to \"true\".
32
+ * request includes the {@code includePlaintextKey} parameter and sets its value to \"true\".
33
33
  *
34
34
  */
35
35
  "plaintextChecksum"?: string;