oci-redis 2.130.0 → 2.131.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 (99) hide show
  1. package/index.d.ts +3 -0
  2. package/index.js +4 -1
  3. package/index.js.map +1 -1
  4. package/lib/client.d.ts +148 -1
  5. package/lib/client.js +624 -2
  6. package/lib/client.js.map +1 -1
  7. package/lib/model/change-oci-cache-backup-compartment-details.d.ts +27 -0
  8. package/lib/model/change-oci-cache-backup-compartment-details.js +29 -0
  9. package/lib/model/change-oci-cache-backup-compartment-details.js.map +1 -0
  10. package/lib/model/create-identity-token-details.d.ts +0 -18
  11. package/lib/model/create-identity-token-details.js.map +1 -1
  12. package/lib/model/create-oci-cache-backup-details.d.ts +63 -0
  13. package/lib/model/create-oci-cache-backup-details.js +29 -0
  14. package/lib/model/create-oci-cache-backup-details.js.map +1 -0
  15. package/lib/model/create-redis-cluster-details.d.ts +6 -0
  16. package/lib/model/create-redis-cluster-details.js +30 -2
  17. package/lib/model/create-redis-cluster-details.js.map +1 -1
  18. package/lib/model/export-oci-cache-backup-to-object-storage-details.d.ts +33 -0
  19. package/lib/model/export-oci-cache-backup-to-object-storage-details.js +29 -0
  20. package/lib/model/export-oci-cache-backup-to-object-storage-details.js.map +1 -0
  21. package/lib/model/import-oci-cache-from-object-storage-details.d.ts +34 -0
  22. package/lib/model/import-oci-cache-from-object-storage-details.js +61 -0
  23. package/lib/model/import-oci-cache-from-object-storage-details.js.map +1 -0
  24. package/lib/model/import-oci-cache-from-object-storage-object.d.ts +25 -0
  25. package/lib/model/import-oci-cache-from-object-storage-object.js +29 -0
  26. package/lib/model/import-oci-cache-from-object-storage-object.js.map +1 -0
  27. package/lib/model/index.d.ts +18 -0
  28. package/lib/model/index.js +20 -2
  29. package/lib/model/index.js.map +1 -1
  30. package/lib/model/oci-cache-backup-collection.d.ts +26 -0
  31. package/lib/model/oci-cache-backup-collection.js +61 -0
  32. package/lib/model/oci-cache-backup-collection.js.map +1 -0
  33. package/lib/model/oci-cache-backup-summary.d.ts +106 -0
  34. package/lib/model/oci-cache-backup-summary.js +39 -0
  35. package/lib/model/oci-cache-backup-summary.js.map +1 -0
  36. package/lib/model/oci-cache-backup.d.ts +144 -0
  37. package/lib/model/oci-cache-backup.js +63 -0
  38. package/lib/model/oci-cache-backup.js.map +1 -0
  39. package/lib/model/operation-type.d.ts +5 -0
  40. package/lib/model/operation-type.js +5 -0
  41. package/lib/model/operation-type.js.map +1 -1
  42. package/lib/model/redis-cluster-summary.d.ts +4 -0
  43. package/lib/model/redis-cluster-summary.js.map +1 -1
  44. package/lib/model/redis-cluster.d.ts +5 -0
  45. package/lib/model/redis-cluster.js +6 -0
  46. package/lib/model/redis-cluster.js.map +1 -1
  47. package/lib/model/update-oci-cache-backup-details.d.ts +51 -0
  48. package/lib/model/update-oci-cache-backup-details.js +29 -0
  49. package/lib/model/update-oci-cache-backup-details.js.map +1 -0
  50. package/lib/ocicachebackup-waiter.d.ts +29 -0
  51. package/lib/ocicachebackup-waiter.js +65 -0
  52. package/lib/ocicachebackup-waiter.js.map +1 -0
  53. package/lib/request/change-oci-cache-backup-compartment-request.d.ts +49 -0
  54. package/lib/request/change-oci-cache-backup-compartment-request.js +15 -0
  55. package/lib/request/change-oci-cache-backup-compartment-request.js.map +1 -0
  56. package/lib/request/create-oci-cache-backup-request.d.ts +36 -0
  57. package/lib/request/create-oci-cache-backup-request.js +15 -0
  58. package/lib/request/create-oci-cache-backup-request.js.map +1 -0
  59. package/lib/request/delete-oci-cache-backup-request.d.ts +35 -0
  60. package/lib/request/delete-oci-cache-backup-request.js +15 -0
  61. package/lib/request/delete-oci-cache-backup-request.js.map +1 -0
  62. package/lib/request/export-oci-cache-backup-to-object-storage-request.d.ts +49 -0
  63. package/lib/request/export-oci-cache-backup-to-object-storage-request.js +15 -0
  64. package/lib/request/export-oci-cache-backup-to-object-storage-request.js.map +1 -0
  65. package/lib/request/get-oci-cache-backup-request.d.ts +26 -0
  66. package/lib/request/get-oci-cache-backup-request.js +15 -0
  67. package/lib/request/get-oci-cache-backup-request.js.map +1 -0
  68. package/lib/request/index.d.ts +14 -0
  69. package/lib/request/index.js +3 -1
  70. package/lib/request/index.js.map +1 -1
  71. package/lib/request/list-oci-cache-backups-request.d.ts +66 -0
  72. package/lib/request/list-oci-cache-backups-request.js +24 -0
  73. package/lib/request/list-oci-cache-backups-request.js.map +1 -0
  74. package/lib/request/update-oci-cache-backup-request.d.ts +40 -0
  75. package/lib/request/update-oci-cache-backup-request.js +15 -0
  76. package/lib/request/update-oci-cache-backup-request.js.map +1 -0
  77. package/lib/response/change-oci-cache-backup-compartment-response.d.ts +25 -0
  78. package/lib/response/change-oci-cache-backup-compartment-response.js +15 -0
  79. package/lib/response/change-oci-cache-backup-compartment-response.js.map +1 -0
  80. package/lib/response/create-oci-cache-backup-response.d.ts +35 -0
  81. package/lib/response/create-oci-cache-backup-response.js +15 -0
  82. package/lib/response/create-oci-cache-backup-response.js.map +1 -0
  83. package/lib/response/delete-oci-cache-backup-response.d.ts +25 -0
  84. package/lib/response/delete-oci-cache-backup-response.js +15 -0
  85. package/lib/response/delete-oci-cache-backup-response.js.map +1 -0
  86. package/lib/response/export-oci-cache-backup-to-object-storage-response.d.ts +25 -0
  87. package/lib/response/export-oci-cache-backup-to-object-storage-response.js +15 -0
  88. package/lib/response/export-oci-cache-backup-to-object-storage-response.js.map +1 -0
  89. package/lib/response/get-oci-cache-backup-response.d.ts +30 -0
  90. package/lib/response/get-oci-cache-backup-response.js +15 -0
  91. package/lib/response/get-oci-cache-backup-response.js.map +1 -0
  92. package/lib/response/index.d.ts +14 -0
  93. package/lib/response/list-oci-cache-backups-response.d.ts +32 -0
  94. package/lib/response/list-oci-cache-backups-response.js +15 -0
  95. package/lib/response/list-oci-cache-backups-response.js.map +1 -0
  96. package/lib/response/update-oci-cache-backup-response.d.ts +35 -0
  97. package/lib/response/update-oci-cache-backup-response.js +15 -0
  98. package/lib/response/update-oci-cache-backup-response.js.map +1 -0
  99. package/package.json +3 -3
package/lib/client.js CHANGED
@@ -40,10 +40,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
40
40
  });
41
41
  };
42
42
  Object.defineProperty(exports, "__esModule", { value: true });
43
- exports.RedisIdentityClient = exports.RedisIdentityApiKeys = exports.RedisClusterClient = exports.RedisClusterApiKeys = exports.OciCacheUserClient = exports.OciCacheUserApiKeys = exports.OciCacheEngineOptionsClient = exports.OciCacheEngineOptionsApiKeys = exports.OciCacheDefaultConfigSetClient = exports.OciCacheDefaultConfigSetApiKeys = exports.OciCacheConfigSetClient = exports.OciCacheConfigSetApiKeys = void 0;
43
+ exports.RedisIdentityClient = exports.RedisIdentityApiKeys = exports.RedisClusterClient = exports.RedisClusterApiKeys = exports.OciCacheUserClient = exports.OciCacheUserApiKeys = exports.OciCacheEngineOptionsClient = exports.OciCacheEngineOptionsApiKeys = exports.OciCacheDefaultConfigSetClient = exports.OciCacheDefaultConfigSetApiKeys = exports.OciCacheConfigSetClient = exports.OciCacheConfigSetApiKeys = exports.OciCacheBackupClient = exports.OciCacheBackupApiKeys = void 0;
44
44
  const common = require("oci-common");
45
45
  const model = __importStar(require("./model"));
46
46
  const oci_common_1 = require("oci-common");
47
+ const ocicachebackup_waiter_1 = require("./ocicachebackup-waiter");
47
48
  const ocicacheconfigset_waiter_1 = require("./ocicacheconfigset-waiter");
48
49
  const ocicachedefaultconfigset_waiter_1 = require("./ocicachedefaultconfigset-waiter");
49
50
  const ocicacheuser_waiter_1 = require("./ocicacheuser-waiter");
@@ -53,6 +54,625 @@ const Breaker = require("opossum");
53
54
  // ===============================================
54
55
  // This file is autogenerated - Please do not edit
55
56
  // ===============================================
57
+ var OciCacheBackupApiKeys;
58
+ (function (OciCacheBackupApiKeys) {
59
+ })(OciCacheBackupApiKeys = exports.OciCacheBackupApiKeys || (exports.OciCacheBackupApiKeys = {}));
60
+ /**
61
+ * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
62
+ */
63
+ class OciCacheBackupClient {
64
+ constructor(params, clientConfiguration) {
65
+ this["_realmSpecificEndpointTemplateEnabled"] = undefined;
66
+ this["_endpoint"] = "";
67
+ this["_defaultHeaders"] = {};
68
+ this._circuitBreaker = null;
69
+ this._httpOptions = undefined;
70
+ this._bodyDuplexMode = undefined;
71
+ this.targetService = "OciCacheBackup";
72
+ this._regionId = "";
73
+ this._lastSetRegionOrRegionId = "";
74
+ const requestSigner = params.authenticationDetailsProvider
75
+ ? new common.DefaultRequestSigner(params.authenticationDetailsProvider)
76
+ : null;
77
+ this._authProvider = params.authenticationDetailsProvider;
78
+ if (clientConfiguration) {
79
+ this._clientConfiguration = clientConfiguration;
80
+ this._circuitBreaker = clientConfiguration.circuitBreaker
81
+ ? clientConfiguration.circuitBreaker.circuit
82
+ : null;
83
+ this._httpOptions = clientConfiguration.httpOptions
84
+ ? clientConfiguration.httpOptions
85
+ : undefined;
86
+ this._bodyDuplexMode = clientConfiguration.bodyDuplexMode
87
+ ? clientConfiguration.bodyDuplexMode
88
+ : undefined;
89
+ }
90
+ if (!oci_common_2.developerToolConfiguration.isServiceEnabled("redis")) {
91
+ let errmsg = "The developerToolConfiguration configuration disabled this service, this behavior is controlled by developerToolConfiguration.ociEnabledServiceSet variable. Please check if your local developer_tool_configuration file has configured the service you're targeting or contact the cloud provider on the availability of this service : ";
92
+ throw errmsg.concat("redis");
93
+ }
94
+ // if circuit breaker is not created, check if circuit breaker system is enabled to use default circuit breaker
95
+ const specCircuitBreakerEnabled = true;
96
+ if (!this._circuitBreaker &&
97
+ common.utils.isCircuitBreakerSystemEnabled(clientConfiguration) &&
98
+ (specCircuitBreakerEnabled || common.CircuitBreaker.DefaultCircuitBreakerOverriden)) {
99
+ this._circuitBreaker = new common.CircuitBreaker().circuit;
100
+ }
101
+ this._httpClient =
102
+ params.httpClient ||
103
+ new common.FetchHttpClient(requestSigner, this._circuitBreaker, this._httpOptions, this._bodyDuplexMode);
104
+ if (params.authenticationDetailsProvider &&
105
+ common.isRegionProvider(params.authenticationDetailsProvider)) {
106
+ const provider = params.authenticationDetailsProvider;
107
+ if (provider.getRegion()) {
108
+ this.region = provider.getRegion();
109
+ }
110
+ }
111
+ }
112
+ /**
113
+ * Get the endpoint that is being used to call (ex, https://www.example.com).
114
+ */
115
+ get endpoint() {
116
+ return this._endpoint;
117
+ }
118
+ /**
119
+ * Sets the endpoint to call (ex, https://www.example.com).
120
+ * @param endpoint The endpoint of the service.
121
+ */
122
+ set endpoint(endpoint) {
123
+ this._endpoint = endpoint;
124
+ this._endpoint = this._endpoint + "/20220315";
125
+ if (this.logger)
126
+ this.logger.info(`OciCacheBackupClient endpoint set to ${this._endpoint}`);
127
+ }
128
+ get logger() {
129
+ return common.LOG.logger;
130
+ }
131
+ /**
132
+ * Determines whether realm specific endpoint should be used or not.
133
+ * Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
134
+ * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template
135
+ */
136
+ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled) {
137
+ this._realmSpecificEndpointTemplateEnabled = realmSpecificEndpointTemplateEnabled;
138
+ if (this.logger)
139
+ this.logger.info(`realmSpecificEndpointTemplateEnabled set to ${this._realmSpecificEndpointTemplateEnabled}`);
140
+ if (this._lastSetRegionOrRegionId === common.Region.REGION_STRING) {
141
+ this.endpoint = common.EndpointBuilder.createEndpointFromRegion(OciCacheBackupClient.serviceEndpointTemplate, this._region, OciCacheBackupClient.endpointServiceName);
142
+ }
143
+ else if (this._lastSetRegionOrRegionId === common.Region.REGION_ID_STRING) {
144
+ this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(OciCacheBackupClient.serviceEndpointTemplate, this._regionId, OciCacheBackupClient.endpointServiceName);
145
+ }
146
+ }
147
+ /**
148
+ * Sets the region to call (ex, Region.US_PHOENIX_1).
149
+ * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
150
+ * @param region The region of the service.
151
+ */
152
+ set region(region) {
153
+ this._region = region;
154
+ this.endpoint = common.EndpointBuilder.createEndpointFromRegion(OciCacheBackupClient.serviceEndpointTemplate, region, OciCacheBackupClient.endpointServiceName);
155
+ this._lastSetRegionOrRegionId = common.Region.REGION_STRING;
156
+ }
157
+ /**
158
+ * Sets the regionId to call (ex, 'us-phoenix-1').
159
+ *
160
+ * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}.
161
+ * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1
162
+ * and then call {@link #endpoint(String) endpoint}.
163
+ * @param regionId The public region ID.
164
+ */
165
+ set regionId(regionId) {
166
+ this._regionId = regionId;
167
+ this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(OciCacheBackupClient.serviceEndpointTemplate, regionId, OciCacheBackupClient.endpointServiceName);
168
+ this._lastSetRegionOrRegionId = common.Region.REGION_ID_STRING;
169
+ }
170
+ /**
171
+ * Creates a new OciCacheBackupWaiter for resources for this service.
172
+ *
173
+ * @param config The waiter configuration for termination and delay strategy
174
+ * @return The service waiters.
175
+ */
176
+ createWaiters(config) {
177
+ this._waiters = new ocicachebackup_waiter_1.OciCacheBackupWaiter(this, config);
178
+ return this._waiters;
179
+ }
180
+ /**
181
+ * Gets the waiters available for resources for this service.
182
+ *
183
+ * @return The service waiters.
184
+ */
185
+ getWaiters() {
186
+ if (this._waiters) {
187
+ return this._waiters;
188
+ }
189
+ throw Error("Waiters do not exist. Please create waiters.");
190
+ }
191
+ /**
192
+ * Shutdown the circuit breaker used by the client when it is no longer needed
193
+ */
194
+ shutdownCircuitBreaker() {
195
+ if (this._circuitBreaker) {
196
+ this._circuitBreaker.shutdown();
197
+ }
198
+ }
199
+ /**
200
+ * Close the provider if possible which in turn shuts down any associated circuit breaker
201
+ */
202
+ closeProvider() {
203
+ if (this._authProvider) {
204
+ if (this._authProvider instanceof common.AbstractRequestingAuthenticationDetailsProvider)
205
+ (this._authProvider).closeProvider();
206
+ }
207
+ }
208
+ /**
209
+ * Close the client once it is no longer needed
210
+ */
211
+ close() {
212
+ this.shutdownCircuitBreaker();
213
+ this.closeProvider();
214
+ }
215
+ /**
216
+ * Moves an OCI Cache Backup resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
217
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
218
+ * @param ChangeOciCacheBackupCompartmentRequest
219
+ * @return ChangeOciCacheBackupCompartmentResponse
220
+ * @throws OciError when an error occurs
221
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/redis/ChangeOciCacheBackupCompartment.ts.html |here} to see how to use ChangeOciCacheBackupCompartment API.
222
+ */
223
+ changeOciCacheBackupCompartment(changeOciCacheBackupCompartmentRequest) {
224
+ return __awaiter(this, void 0, void 0, function* () {
225
+ if (this.logger)
226
+ this.logger.debug("Calling operation OciCacheBackupClient#changeOciCacheBackupCompartment.");
227
+ const operationName = "changeOciCacheBackupCompartment";
228
+ const apiReferenceLink = "";
229
+ const pathParams = {
230
+ "{ociCacheBackupId}": changeOciCacheBackupCompartmentRequest.ociCacheBackupId
231
+ };
232
+ const queryParams = {};
233
+ let headerParams = {
234
+ "Content-Type": common.Constants.APPLICATION_JSON,
235
+ "if-match": changeOciCacheBackupCompartmentRequest.ifMatch,
236
+ "opc-request-id": changeOciCacheBackupCompartmentRequest.opcRequestId,
237
+ "opc-retry-token": changeOciCacheBackupCompartmentRequest.opcRetryToken
238
+ };
239
+ const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
240
+ const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, changeOciCacheBackupCompartmentRequest.retryConfiguration, specRetryConfiguration);
241
+ if (this.logger)
242
+ retrier.logger = this.logger;
243
+ const request = yield oci_common_2.composeRequest({
244
+ baseEndpoint: this._endpoint,
245
+ defaultHeaders: this._defaultHeaders,
246
+ path: "/ociCacheBackups/{ociCacheBackupId}/actions/changeCompartment",
247
+ method: "POST",
248
+ bodyContent: common.ObjectSerializer.serialize(changeOciCacheBackupCompartmentRequest.changeOciCacheBackupCompartmentDetails, "ChangeOciCacheBackupCompartmentDetails", model.ChangeOciCacheBackupCompartmentDetails.getJsonObj),
249
+ pathParams: pathParams,
250
+ headerParams: headerParams,
251
+ queryParams: queryParams
252
+ });
253
+ try {
254
+ const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
255
+ const sdkResponse = oci_common_2.composeResponse({
256
+ responseObject: {},
257
+ responseHeaders: [
258
+ {
259
+ value: response.headers.get("opc-work-request-id"),
260
+ key: "opcWorkRequestId",
261
+ dataType: "string"
262
+ },
263
+ {
264
+ value: response.headers.get("opc-request-id"),
265
+ key: "opcRequestId",
266
+ dataType: "string"
267
+ }
268
+ ]
269
+ });
270
+ return sdkResponse;
271
+ }
272
+ catch (err) {
273
+ throw err;
274
+ }
275
+ });
276
+ }
277
+ /**
278
+ * Creates a new OCI Cache Backup.
279
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
280
+ * @param CreateOciCacheBackupRequest
281
+ * @return CreateOciCacheBackupResponse
282
+ * @throws OciError when an error occurs
283
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/redis/CreateOciCacheBackup.ts.html |here} to see how to use CreateOciCacheBackup API.
284
+ */
285
+ createOciCacheBackup(createOciCacheBackupRequest) {
286
+ return __awaiter(this, void 0, void 0, function* () {
287
+ if (this.logger)
288
+ this.logger.debug("Calling operation OciCacheBackupClient#createOciCacheBackup.");
289
+ const operationName = "createOciCacheBackup";
290
+ const apiReferenceLink = "";
291
+ const pathParams = {};
292
+ const queryParams = {};
293
+ let headerParams = {
294
+ "Content-Type": common.Constants.APPLICATION_JSON,
295
+ "opc-retry-token": createOciCacheBackupRequest.opcRetryToken,
296
+ "opc-request-id": createOciCacheBackupRequest.opcRequestId
297
+ };
298
+ const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
299
+ const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, createOciCacheBackupRequest.retryConfiguration, specRetryConfiguration);
300
+ if (this.logger)
301
+ retrier.logger = this.logger;
302
+ const request = yield oci_common_2.composeRequest({
303
+ baseEndpoint: this._endpoint,
304
+ defaultHeaders: this._defaultHeaders,
305
+ path: "/ociCacheBackups",
306
+ method: "POST",
307
+ bodyContent: common.ObjectSerializer.serialize(createOciCacheBackupRequest.createOciCacheBackupDetails, "CreateOciCacheBackupDetails", model.CreateOciCacheBackupDetails.getJsonObj),
308
+ pathParams: pathParams,
309
+ headerParams: headerParams,
310
+ queryParams: queryParams
311
+ });
312
+ try {
313
+ const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
314
+ const sdkResponse = oci_common_2.composeResponse({
315
+ responseObject: {},
316
+ body: yield response.json(),
317
+ bodyKey: "ociCacheBackup",
318
+ bodyModel: model.OciCacheBackup,
319
+ type: "model.OciCacheBackup",
320
+ responseHeaders: [
321
+ {
322
+ value: response.headers.get("etag"),
323
+ key: "etag",
324
+ dataType: "string"
325
+ },
326
+ {
327
+ value: response.headers.get("opc-work-request-id"),
328
+ key: "opcWorkRequestId",
329
+ dataType: "string"
330
+ },
331
+ {
332
+ value: response.headers.get("opc-request-id"),
333
+ key: "opcRequestId",
334
+ dataType: "string"
335
+ }
336
+ ]
337
+ });
338
+ return sdkResponse;
339
+ }
340
+ catch (err) {
341
+ throw err;
342
+ }
343
+ });
344
+ }
345
+ /**
346
+ * Deletes an OCI Cache Backup resource by identifier
347
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
348
+ * @param DeleteOciCacheBackupRequest
349
+ * @return DeleteOciCacheBackupResponse
350
+ * @throws OciError when an error occurs
351
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/redis/DeleteOciCacheBackup.ts.html |here} to see how to use DeleteOciCacheBackup API.
352
+ */
353
+ deleteOciCacheBackup(deleteOciCacheBackupRequest) {
354
+ return __awaiter(this, void 0, void 0, function* () {
355
+ if (this.logger)
356
+ this.logger.debug("Calling operation OciCacheBackupClient#deleteOciCacheBackup.");
357
+ const operationName = "deleteOciCacheBackup";
358
+ const apiReferenceLink = "";
359
+ const pathParams = {
360
+ "{ociCacheBackupId}": deleteOciCacheBackupRequest.ociCacheBackupId
361
+ };
362
+ const queryParams = {};
363
+ let headerParams = {
364
+ "Content-Type": common.Constants.APPLICATION_JSON,
365
+ "if-match": deleteOciCacheBackupRequest.ifMatch,
366
+ "opc-request-id": deleteOciCacheBackupRequest.opcRequestId
367
+ };
368
+ const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
369
+ const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, deleteOciCacheBackupRequest.retryConfiguration, specRetryConfiguration);
370
+ if (this.logger)
371
+ retrier.logger = this.logger;
372
+ const request = yield oci_common_2.composeRequest({
373
+ baseEndpoint: this._endpoint,
374
+ defaultHeaders: this._defaultHeaders,
375
+ path: "/ociCacheBackups/{ociCacheBackupId}",
376
+ method: "DELETE",
377
+ pathParams: pathParams,
378
+ headerParams: headerParams,
379
+ queryParams: queryParams
380
+ });
381
+ try {
382
+ const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
383
+ const sdkResponse = oci_common_2.composeResponse({
384
+ responseObject: {},
385
+ responseHeaders: [
386
+ {
387
+ value: response.headers.get("opc-work-request-id"),
388
+ key: "opcWorkRequestId",
389
+ dataType: "string"
390
+ },
391
+ {
392
+ value: response.headers.get("opc-request-id"),
393
+ key: "opcRequestId",
394
+ dataType: "string"
395
+ }
396
+ ]
397
+ });
398
+ return sdkResponse;
399
+ }
400
+ catch (err) {
401
+ throw err;
402
+ }
403
+ });
404
+ }
405
+ /**
406
+ * Initiates an asynchronous export of the backup\u2019s RDB file(s) to the specified Object Storage bucket. The service generates the object names. For sharded backups, one object is written per shard under the optional prefix.
407
+ *
408
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
409
+ * @param ExportOciCacheBackupToObjectStorageRequest
410
+ * @return ExportOciCacheBackupToObjectStorageResponse
411
+ * @throws OciError when an error occurs
412
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/redis/ExportOciCacheBackupToObjectStorage.ts.html |here} to see how to use ExportOciCacheBackupToObjectStorage API.
413
+ */
414
+ exportOciCacheBackupToObjectStorage(exportOciCacheBackupToObjectStorageRequest) {
415
+ return __awaiter(this, void 0, void 0, function* () {
416
+ if (this.logger)
417
+ this.logger.debug("Calling operation OciCacheBackupClient#exportOciCacheBackupToObjectStorage.");
418
+ const operationName = "exportOciCacheBackupToObjectStorage";
419
+ const apiReferenceLink = "";
420
+ const pathParams = {
421
+ "{ociCacheBackupId}": exportOciCacheBackupToObjectStorageRequest.ociCacheBackupId
422
+ };
423
+ const queryParams = {};
424
+ let headerParams = {
425
+ "Content-Type": common.Constants.APPLICATION_JSON,
426
+ "if-match": exportOciCacheBackupToObjectStorageRequest.ifMatch,
427
+ "opc-retry-token": exportOciCacheBackupToObjectStorageRequest.opcRetryToken,
428
+ "opc-request-id": exportOciCacheBackupToObjectStorageRequest.opcRequestId
429
+ };
430
+ const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
431
+ const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, exportOciCacheBackupToObjectStorageRequest.retryConfiguration, specRetryConfiguration);
432
+ if (this.logger)
433
+ retrier.logger = this.logger;
434
+ const request = yield oci_common_2.composeRequest({
435
+ baseEndpoint: this._endpoint,
436
+ defaultHeaders: this._defaultHeaders,
437
+ path: "/ociCacheBackups/{ociCacheBackupId}/actions/exportToObjectStorage",
438
+ method: "POST",
439
+ bodyContent: common.ObjectSerializer.serialize(exportOciCacheBackupToObjectStorageRequest.exportOciCacheBackupToObjectStorageDetails, "ExportOciCacheBackupToObjectStorageDetails", model.ExportOciCacheBackupToObjectStorageDetails.getJsonObj),
440
+ pathParams: pathParams,
441
+ headerParams: headerParams,
442
+ queryParams: queryParams
443
+ });
444
+ try {
445
+ const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
446
+ const sdkResponse = oci_common_2.composeResponse({
447
+ responseObject: {},
448
+ responseHeaders: [
449
+ {
450
+ value: response.headers.get("opc-work-request-id"),
451
+ key: "opcWorkRequestId",
452
+ dataType: "string"
453
+ },
454
+ {
455
+ value: response.headers.get("opc-request-id"),
456
+ key: "opcRequestId",
457
+ dataType: "string"
458
+ }
459
+ ]
460
+ });
461
+ return sdkResponse;
462
+ }
463
+ catch (err) {
464
+ throw err;
465
+ }
466
+ });
467
+ }
468
+ /**
469
+ * Gets an OCI Cache Backup by identifier
470
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
471
+ * @param GetOciCacheBackupRequest
472
+ * @return GetOciCacheBackupResponse
473
+ * @throws OciError when an error occurs
474
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/redis/GetOciCacheBackup.ts.html |here} to see how to use GetOciCacheBackup API.
475
+ */
476
+ getOciCacheBackup(getOciCacheBackupRequest) {
477
+ return __awaiter(this, void 0, void 0, function* () {
478
+ if (this.logger)
479
+ this.logger.debug("Calling operation OciCacheBackupClient#getOciCacheBackup.");
480
+ const operationName = "getOciCacheBackup";
481
+ const apiReferenceLink = "";
482
+ const pathParams = {
483
+ "{ociCacheBackupId}": getOciCacheBackupRequest.ociCacheBackupId
484
+ };
485
+ const queryParams = {};
486
+ let headerParams = {
487
+ "Content-Type": common.Constants.APPLICATION_JSON,
488
+ "opc-request-id": getOciCacheBackupRequest.opcRequestId
489
+ };
490
+ const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
491
+ const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, getOciCacheBackupRequest.retryConfiguration, specRetryConfiguration);
492
+ if (this.logger)
493
+ retrier.logger = this.logger;
494
+ const request = yield oci_common_2.composeRequest({
495
+ baseEndpoint: this._endpoint,
496
+ defaultHeaders: this._defaultHeaders,
497
+ path: "/ociCacheBackups/{ociCacheBackupId}",
498
+ method: "GET",
499
+ pathParams: pathParams,
500
+ headerParams: headerParams,
501
+ queryParams: queryParams
502
+ });
503
+ try {
504
+ const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
505
+ const sdkResponse = oci_common_2.composeResponse({
506
+ responseObject: {},
507
+ body: yield response.json(),
508
+ bodyKey: "ociCacheBackup",
509
+ bodyModel: model.OciCacheBackup,
510
+ type: "model.OciCacheBackup",
511
+ responseHeaders: [
512
+ {
513
+ value: response.headers.get("etag"),
514
+ key: "etag",
515
+ dataType: "string"
516
+ },
517
+ {
518
+ value: response.headers.get("opc-request-id"),
519
+ key: "opcRequestId",
520
+ dataType: "string"
521
+ }
522
+ ]
523
+ });
524
+ return sdkResponse;
525
+ }
526
+ catch (err) {
527
+ throw err;
528
+ }
529
+ });
530
+ }
531
+ /**
532
+ * Returns a list of OCI Cache Backups.
533
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
534
+ * @param ListOciCacheBackupsRequest
535
+ * @return ListOciCacheBackupsResponse
536
+ * @throws OciError when an error occurs
537
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/redis/ListOciCacheBackups.ts.html |here} to see how to use ListOciCacheBackups API.
538
+ */
539
+ listOciCacheBackups(listOciCacheBackupsRequest) {
540
+ return __awaiter(this, void 0, void 0, function* () {
541
+ if (this.logger)
542
+ this.logger.debug("Calling operation OciCacheBackupClient#listOciCacheBackups.");
543
+ const operationName = "listOciCacheBackups";
544
+ const apiReferenceLink = "";
545
+ const pathParams = {};
546
+ const queryParams = {
547
+ "compartmentId": listOciCacheBackupsRequest.compartmentId,
548
+ "lifecycleState": listOciCacheBackupsRequest.lifecycleState,
549
+ "displayName": listOciCacheBackupsRequest.displayName,
550
+ "ociCacheBackupId": listOciCacheBackupsRequest.ociCacheBackupId,
551
+ "sourceClusterId": listOciCacheBackupsRequest.sourceClusterId,
552
+ "limit": listOciCacheBackupsRequest.limit,
553
+ "page": listOciCacheBackupsRequest.page,
554
+ "sortOrder": listOciCacheBackupsRequest.sortOrder,
555
+ "sortBy": listOciCacheBackupsRequest.sortBy
556
+ };
557
+ let headerParams = {
558
+ "Content-Type": common.Constants.APPLICATION_JSON,
559
+ "opc-request-id": listOciCacheBackupsRequest.opcRequestId
560
+ };
561
+ const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
562
+ const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, listOciCacheBackupsRequest.retryConfiguration, specRetryConfiguration);
563
+ if (this.logger)
564
+ retrier.logger = this.logger;
565
+ const request = yield oci_common_2.composeRequest({
566
+ baseEndpoint: this._endpoint,
567
+ defaultHeaders: this._defaultHeaders,
568
+ path: "/ociCacheBackups",
569
+ method: "GET",
570
+ pathParams: pathParams,
571
+ headerParams: headerParams,
572
+ queryParams: queryParams
573
+ });
574
+ try {
575
+ const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
576
+ const sdkResponse = oci_common_2.composeResponse({
577
+ responseObject: {},
578
+ body: yield response.json(),
579
+ bodyKey: "ociCacheBackupCollection",
580
+ bodyModel: model.OciCacheBackupCollection,
581
+ type: "model.OciCacheBackupCollection",
582
+ responseHeaders: [
583
+ {
584
+ value: response.headers.get("opc-request-id"),
585
+ key: "opcRequestId",
586
+ dataType: "string"
587
+ },
588
+ {
589
+ value: response.headers.get("opc-next-page"),
590
+ key: "opcNextPage",
591
+ dataType: "string"
592
+ }
593
+ ]
594
+ });
595
+ return sdkResponse;
596
+ }
597
+ catch (err) {
598
+ throw err;
599
+ }
600
+ });
601
+ }
602
+ /**
603
+ * Updates the OCI Cache Backup
604
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
605
+ * @param UpdateOciCacheBackupRequest
606
+ * @return UpdateOciCacheBackupResponse
607
+ * @throws OciError when an error occurs
608
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/redis/UpdateOciCacheBackup.ts.html |here} to see how to use UpdateOciCacheBackup API.
609
+ */
610
+ updateOciCacheBackup(updateOciCacheBackupRequest) {
611
+ return __awaiter(this, void 0, void 0, function* () {
612
+ if (this.logger)
613
+ this.logger.debug("Calling operation OciCacheBackupClient#updateOciCacheBackup.");
614
+ const operationName = "updateOciCacheBackup";
615
+ const apiReferenceLink = "";
616
+ const pathParams = {
617
+ "{ociCacheBackupId}": updateOciCacheBackupRequest.ociCacheBackupId
618
+ };
619
+ const queryParams = {};
620
+ let headerParams = {
621
+ "Content-Type": common.Constants.APPLICATION_JSON,
622
+ "if-match": updateOciCacheBackupRequest.ifMatch,
623
+ "opc-request-id": updateOciCacheBackupRequest.opcRequestId
624
+ };
625
+ const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
626
+ const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, updateOciCacheBackupRequest.retryConfiguration, specRetryConfiguration);
627
+ if (this.logger)
628
+ retrier.logger = this.logger;
629
+ const request = yield oci_common_2.composeRequest({
630
+ baseEndpoint: this._endpoint,
631
+ defaultHeaders: this._defaultHeaders,
632
+ path: "/ociCacheBackups/{ociCacheBackupId}",
633
+ method: "PUT",
634
+ bodyContent: common.ObjectSerializer.serialize(updateOciCacheBackupRequest.updateOciCacheBackupDetails, "UpdateOciCacheBackupDetails", model.UpdateOciCacheBackupDetails.getJsonObj),
635
+ pathParams: pathParams,
636
+ headerParams: headerParams,
637
+ queryParams: queryParams
638
+ });
639
+ try {
640
+ const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
641
+ const sdkResponse = oci_common_2.composeResponse({
642
+ responseObject: {},
643
+ body: yield response.json(),
644
+ bodyKey: "ociCacheBackup",
645
+ bodyModel: model.OciCacheBackup,
646
+ type: "model.OciCacheBackup",
647
+ responseHeaders: [
648
+ {
649
+ value: response.headers.get("etag"),
650
+ key: "etag",
651
+ dataType: "string"
652
+ },
653
+ {
654
+ value: response.headers.get("opc-work-request-id"),
655
+ key: "opcWorkRequestId",
656
+ dataType: "string"
657
+ },
658
+ {
659
+ value: response.headers.get("opc-request-id"),
660
+ key: "opcRequestId",
661
+ dataType: "string"
662
+ }
663
+ ]
664
+ });
665
+ return sdkResponse;
666
+ }
667
+ catch (err) {
668
+ throw err;
669
+ }
670
+ });
671
+ }
672
+ }
673
+ exports.OciCacheBackupClient = OciCacheBackupClient;
674
+ OciCacheBackupClient.serviceEndpointTemplate = "https://redis.{region}.oci.{secondLevelDomain}";
675
+ OciCacheBackupClient.endpointServiceName = "";
56
676
  var OciCacheConfigSetApiKeys;
57
677
  (function (OciCacheConfigSetApiKeys) {
58
678
  })(OciCacheConfigSetApiKeys = exports.OciCacheConfigSetApiKeys || (exports.OciCacheConfigSetApiKeys = {}));
@@ -2171,7 +2791,9 @@ class RedisClusterClient {
2171
2791
  });
2172
2792
  }
2173
2793
  /**
2174
- * Creates a new OCI Cache cluster. A cluster is a memory-based storage solution. For more information, see [OCI Cache](https://docs.oracle.com/iaas/Content/ocicache/home.htm).
2794
+ * Creates a new OCI Cache cluster. A cluster is a memory-based storage solution.
2795
+ * You can optionally initialize the cluster data by restoring from an OCI Cache Backup (backupId) or by importing from Object Storage RDB file(s) (importFromObjectStorageDetails).
2796
+ * For more information, see [OCI Cache](https://docs.oracle.com/iaas/Content/ocicache/home.htm).
2175
2797
  *
2176
2798
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
2177
2799
  * @param CreateRedisClusterRequest