oci-queue 2.123.1 → 2.125.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 (97) hide show
  1. package/lib/client.d.ts +51 -1
  2. package/lib/client.js +336 -7
  3. package/lib/client.js.map +1 -1
  4. package/lib/model/capability-details.d.ts +22 -0
  5. package/lib/model/capability-details.js +72 -0
  6. package/lib/model/capability-details.js.map +1 -0
  7. package/lib/model/consumer-group-collection.d.ts +26 -0
  8. package/lib/model/consumer-group-collection.js +61 -0
  9. package/lib/model/consumer-group-collection.js.map +1 -0
  10. package/lib/model/consumer-group-summary.d.ts +87 -0
  11. package/lib/model/consumer-group-summary.js +29 -0
  12. package/lib/model/consumer-group-summary.js.map +1 -0
  13. package/lib/model/consumer-group.d.ts +110 -0
  14. package/lib/model/consumer-group.js +44 -0
  15. package/lib/model/consumer-group.js.map +1 -0
  16. package/lib/model/consumer-groups-capability-details.d.ts +47 -0
  17. package/lib/model/consumer-groups-capability-details.js +54 -0
  18. package/lib/model/consumer-groups-capability-details.js.map +1 -0
  19. package/lib/model/create-consumer-group-details.d.ts +64 -0
  20. package/lib/model/create-consumer-group-details.js +29 -0
  21. package/lib/model/create-consumer-group-details.js.map +1 -0
  22. package/lib/model/create-queue-details.d.ts +5 -0
  23. package/lib/model/create-queue-details.js +34 -2
  24. package/lib/model/create-queue-details.js.map +1 -1
  25. package/lib/model/index.d.ts +18 -0
  26. package/lib/model/index.js +19 -1
  27. package/lib/model/index.js.map +1 -1
  28. package/lib/model/large-messages-capability-details.d.ts +24 -0
  29. package/lib/model/large-messages-capability-details.js +54 -0
  30. package/lib/model/large-messages-capability-details.js.map +1 -0
  31. package/lib/model/operation-type.d.ts +3 -0
  32. package/lib/model/operation-type.js +3 -0
  33. package/lib/model/operation-type.js.map +1 -1
  34. package/lib/model/purge-queue-details.d.ts +7 -0
  35. package/lib/model/purge-queue-details.js.map +1 -1
  36. package/lib/model/queue-capability.d.ts +28 -0
  37. package/lib/model/queue-capability.js +39 -0
  38. package/lib/model/queue-capability.js.map +1 -0
  39. package/lib/model/queue-stats.d.ts +4 -0
  40. package/lib/model/queue-stats.js.map +1 -1
  41. package/lib/model/queue-summary.d.ts +13 -0
  42. package/lib/model/queue-summary.js +10 -0
  43. package/lib/model/queue-summary.js.map +1 -1
  44. package/lib/model/queue.d.ts +5 -0
  45. package/lib/model/queue.js +34 -2
  46. package/lib/model/queue.js.map +1 -1
  47. package/lib/model/update-consumer-group-details.d.ts +61 -0
  48. package/lib/model/update-consumer-group-details.js +29 -0
  49. package/lib/model/update-consumer-group-details.js.map +1 -0
  50. package/lib/model/update-queue-details.d.ts +5 -0
  51. package/lib/model/update-queue-details.js +34 -2
  52. package/lib/model/update-queue-details.js.map +1 -1
  53. package/lib/queueadmin-waiter.d.ts +8 -0
  54. package/lib/queueadmin-waiter.js +12 -0
  55. package/lib/queueadmin-waiter.js.map +1 -1
  56. package/lib/request/create-consumer-group-request.d.ts +36 -0
  57. package/lib/request/create-consumer-group-request.js +15 -0
  58. package/lib/request/create-consumer-group-request.js.map +1 -0
  59. package/lib/request/delete-consumer-group-request.d.ts +35 -0
  60. package/lib/request/delete-consumer-group-request.js +15 -0
  61. package/lib/request/delete-consumer-group-request.js.map +1 -0
  62. package/lib/request/delete-message-request.d.ts +4 -0
  63. package/lib/request/delete-messages-request.d.ts +4 -0
  64. package/lib/request/get-consumer-group-request.d.ts +26 -0
  65. package/lib/request/get-consumer-group-request.js +15 -0
  66. package/lib/request/get-consumer-group-request.js.map +1 -0
  67. package/lib/request/get-messages-request.d.ts +4 -0
  68. package/lib/request/get-stats-request.d.ts +4 -0
  69. package/lib/request/index.d.ts +10 -0
  70. package/lib/request/index.js +3 -1
  71. package/lib/request/index.js.map +1 -1
  72. package/lib/request/list-channels-request.d.ts +4 -0
  73. package/lib/request/list-consumer-groups-request.d.ts +62 -0
  74. package/lib/request/list-consumer-groups-request.js +24 -0
  75. package/lib/request/list-consumer-groups-request.js.map +1 -0
  76. package/lib/request/update-consumer-group-request.d.ts +40 -0
  77. package/lib/request/update-consumer-group-request.js +15 -0
  78. package/lib/request/update-consumer-group-request.js.map +1 -0
  79. package/lib/request/update-message-request.d.ts +4 -0
  80. package/lib/request/update-messages-request.d.ts +4 -0
  81. package/lib/response/create-consumer-group-response.d.ts +25 -0
  82. package/lib/response/create-consumer-group-response.js +15 -0
  83. package/lib/response/create-consumer-group-response.js.map +1 -0
  84. package/lib/response/delete-consumer-group-response.d.ts +25 -0
  85. package/lib/response/delete-consumer-group-response.js +15 -0
  86. package/lib/response/delete-consumer-group-response.js.map +1 -0
  87. package/lib/response/get-consumer-group-response.d.ts +30 -0
  88. package/lib/response/get-consumer-group-response.js +15 -0
  89. package/lib/response/get-consumer-group-response.js.map +1 -0
  90. package/lib/response/index.d.ts +10 -0
  91. package/lib/response/list-consumer-groups-response.d.ts +32 -0
  92. package/lib/response/list-consumer-groups-response.js +15 -0
  93. package/lib/response/list-consumer-groups-response.js.map +1 -0
  94. package/lib/response/update-consumer-group-response.d.ts +25 -0
  95. package/lib/response/update-consumer-group-response.js +15 -0
  96. package/lib/response/update-consumer-group-response.js.map +1 -0
  97. package/package.json +3 -3
package/lib/client.d.ts CHANGED
@@ -269,6 +269,16 @@ export declare class QueueAdminClient {
269
269
  * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/queue/ChangeQueueCompartment.ts.html |here} to see how to use ChangeQueueCompartment API.
270
270
  */
271
271
  changeQueueCompartment(changeQueueCompartmentRequest: requests.ChangeQueueCompartmentRequest): Promise<responses.ChangeQueueCompartmentResponse>;
272
+ /**
273
+ * Creates a new consumer group.
274
+ *
275
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
276
+ * @param CreateConsumerGroupRequest
277
+ * @return CreateConsumerGroupResponse
278
+ * @throws OciError when an error occurs
279
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/queue/CreateConsumerGroup.ts.html |here} to see how to use CreateConsumerGroup API.
280
+ */
281
+ createConsumerGroup(createConsumerGroupRequest: requests.CreateConsumerGroupRequest): Promise<responses.CreateConsumerGroupResponse>;
272
282
  /**
273
283
  * Creates a new queue.
274
284
  *
@@ -279,6 +289,15 @@ export declare class QueueAdminClient {
279
289
  * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/queue/CreateQueue.ts.html |here} to see how to use CreateQueue API.
280
290
  */
281
291
  createQueue(createQueueRequest: requests.CreateQueueRequest): Promise<responses.CreateQueueResponse>;
292
+ /**
293
+ * Deletes a consumer group resource by identifier.
294
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
295
+ * @param DeleteConsumerGroupRequest
296
+ * @return DeleteConsumerGroupResponse
297
+ * @throws OciError when an error occurs
298
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/queue/DeleteConsumerGroup.ts.html |here} to see how to use DeleteConsumerGroup API.
299
+ */
300
+ deleteConsumerGroup(deleteConsumerGroupRequest: requests.DeleteConsumerGroupRequest): Promise<responses.DeleteConsumerGroupResponse>;
282
301
  /**
283
302
  * Deletes a queue resource by identifier.
284
303
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
@@ -288,6 +307,15 @@ export declare class QueueAdminClient {
288
307
  * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/queue/DeleteQueue.ts.html |here} to see how to use DeleteQueue API.
289
308
  */
290
309
  deleteQueue(deleteQueueRequest: requests.DeleteQueueRequest): Promise<responses.DeleteQueueResponse>;
310
+ /**
311
+ * Gets a consumer group by identifier.
312
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
313
+ * @param GetConsumerGroupRequest
314
+ * @return GetConsumerGroupResponse
315
+ * @throws OciError when an error occurs
316
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/queue/GetConsumerGroup.ts.html |here} to see how to use GetConsumerGroup API.
317
+ */
318
+ getConsumerGroup(getConsumerGroupRequest: requests.GetConsumerGroupRequest): Promise<responses.GetConsumerGroupResponse>;
291
319
  /**
292
320
  * Gets a queue by identifier.
293
321
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
@@ -306,6 +334,16 @@ export declare class QueueAdminClient {
306
334
  * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/queue/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
307
335
  */
308
336
  getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
337
+ /**
338
+ * Returns a list of consumer groups.
339
+ *
340
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
341
+ * @param ListConsumerGroupsRequest
342
+ * @return ListConsumerGroupsResponse
343
+ * @throws OciError when an error occurs
344
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/queue/ListConsumerGroups.ts.html |here} to see how to use ListConsumerGroups API.
345
+ */
346
+ listConsumerGroups(listConsumerGroupsRequest: requests.ListConsumerGroupsRequest): Promise<responses.ListConsumerGroupsResponse>;
309
347
  /**
310
348
  * Returns a list of queues.
311
349
  *
@@ -347,9 +385,12 @@ export declare class QueueAdminClient {
347
385
  */
348
386
  listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
349
387
  /**
350
- * Deletes all messages present in the queue, or deletes all the messages in the specific channel at the time of invocation. Only one concurrent purge operation is supported for any given queue.
388
+ * Deletes all messages present in the queue or in the specified consumer group, or deletes all the messages in the specific channel at the time of invocation.
389
+ * Only one concurrent purge operation is supported for any given queue.
351
390
  * However multiple concurrent purge operations are supported for different queues.
352
391
  * Purge request without specification of target channels will clean up all messages in the queue and in the child channels.
392
+ * Purge request without specification of consumer group will either clean up all messages in the queue or in the primary consumer group, depending on the presence of the CONSUMER_GROUPS capability on the queue.
393
+ * To purge all consumer groups, the special value 'all' can be used.
353
394
  *
354
395
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
355
396
  * @param PurgeQueueRequest
@@ -358,6 +399,15 @@ export declare class QueueAdminClient {
358
399
  * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/queue/PurgeQueue.ts.html |here} to see how to use PurgeQueue API.
359
400
  */
360
401
  purgeQueue(purgeQueueRequest: requests.PurgeQueueRequest): Promise<responses.PurgeQueueResponse>;
402
+ /**
403
+ * Updates the specified consumer group.
404
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
405
+ * @param UpdateConsumerGroupRequest
406
+ * @return UpdateConsumerGroupResponse
407
+ * @throws OciError when an error occurs
408
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/queue/UpdateConsumerGroup.ts.html |here} to see how to use UpdateConsumerGroup API.
409
+ */
410
+ updateConsumerGroup(updateConsumerGroupRequest: requests.UpdateConsumerGroupRequest): Promise<responses.UpdateConsumerGroupResponse>;
361
411
  /**
362
412
  * Updates the specified queue.
363
413
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
package/lib/client.js CHANGED
@@ -207,7 +207,9 @@ class QueueClient {
207
207
  "{queueId}": deleteMessageRequest.queueId,
208
208
  "{messageReceipt}": deleteMessageRequest.messageReceipt
209
209
  };
210
- const queryParams = {};
210
+ const queryParams = {
211
+ "consumerGroupId": deleteMessageRequest.consumerGroupId
212
+ };
211
213
  let headerParams = {
212
214
  "Content-Type": common.Constants.APPLICATION_JSON,
213
215
  "opc-request-id": deleteMessageRequest.opcRequestId
@@ -264,7 +266,9 @@ class QueueClient {
264
266
  const pathParams = {
265
267
  "{queueId}": deleteMessagesRequest.queueId
266
268
  };
267
- const queryParams = {};
269
+ const queryParams = {
270
+ "consumerGroupId": deleteMessagesRequest.consumerGroupId
271
+ };
268
272
  let headerParams = {
269
273
  "Content-Type": common.Constants.APPLICATION_JSON,
270
274
  "opc-request-id": deleteMessagesRequest.opcRequestId
@@ -333,7 +337,8 @@ class QueueClient {
333
337
  "visibilityInSeconds": getMessagesRequest.visibilityInSeconds,
334
338
  "timeoutInSeconds": getMessagesRequest.timeoutInSeconds,
335
339
  "limit": getMessagesRequest.limit,
336
- "channelFilter": getMessagesRequest.channelFilter
340
+ "channelFilter": getMessagesRequest.channelFilter,
341
+ "consumerGroupId": getMessagesRequest.consumerGroupId
337
342
  };
338
343
  let headerParams = {
339
344
  "Content-Type": common.Constants.APPLICATION_JSON,
@@ -396,7 +401,8 @@ class QueueClient {
396
401
  "{queueId}": getStatsRequest.queueId
397
402
  };
398
403
  const queryParams = {
399
- "channelId": getStatsRequest.channelId
404
+ "channelId": getStatsRequest.channelId,
405
+ "consumerGroupId": getStatsRequest.consumerGroupId
400
406
  };
401
407
  let headerParams = {
402
408
  "Content-Type": common.Constants.APPLICATION_JSON,
@@ -460,6 +466,7 @@ class QueueClient {
460
466
  "{queueId}": listChannelsRequest.queueId
461
467
  };
462
468
  const queryParams = {
469
+ "consumerGroupId": listChannelsRequest.consumerGroupId,
463
470
  "limit": listChannelsRequest.limit,
464
471
  "page": listChannelsRequest.page,
465
472
  "channelFilter": listChannelsRequest.channelFilter
@@ -592,7 +599,9 @@ class QueueClient {
592
599
  "{queueId}": updateMessageRequest.queueId,
593
600
  "{messageReceipt}": updateMessageRequest.messageReceipt
594
601
  };
595
- const queryParams = {};
602
+ const queryParams = {
603
+ "consumerGroupId": updateMessageRequest.consumerGroupId
604
+ };
596
605
  let headerParams = {
597
606
  "Content-Type": common.Constants.APPLICATION_JSON,
598
607
  "opc-request-id": updateMessageRequest.opcRequestId
@@ -654,7 +663,9 @@ class QueueClient {
654
663
  const pathParams = {
655
664
  "{queueId}": updateMessagesRequest.queueId
656
665
  };
657
- const queryParams = {};
666
+ const queryParams = {
667
+ "consumerGroupId": updateMessagesRequest.consumerGroupId
668
+ };
658
669
  let headerParams = {
659
670
  "Content-Type": common.Constants.APPLICATION_JSON,
660
671
  "opc-request-id": updateMessagesRequest.opcRequestId
@@ -919,6 +930,66 @@ class QueueAdminClient {
919
930
  }
920
931
  });
921
932
  }
933
+ /**
934
+ * Creates a new consumer group.
935
+ *
936
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
937
+ * @param CreateConsumerGroupRequest
938
+ * @return CreateConsumerGroupResponse
939
+ * @throws OciError when an error occurs
940
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/queue/CreateConsumerGroup.ts.html |here} to see how to use CreateConsumerGroup API.
941
+ */
942
+ createConsumerGroup(createConsumerGroupRequest) {
943
+ return __awaiter(this, void 0, void 0, function* () {
944
+ if (this.logger)
945
+ this.logger.debug("Calling operation QueueAdminClient#createConsumerGroup.");
946
+ const operationName = "createConsumerGroup";
947
+ const apiReferenceLink = "";
948
+ const pathParams = {};
949
+ const queryParams = {};
950
+ let headerParams = {
951
+ "Content-Type": common.Constants.APPLICATION_JSON,
952
+ "opc-retry-token": createConsumerGroupRequest.opcRetryToken,
953
+ "opc-request-id": createConsumerGroupRequest.opcRequestId
954
+ };
955
+ const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
956
+ const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, createConsumerGroupRequest.retryConfiguration, specRetryConfiguration);
957
+ if (this.logger)
958
+ retrier.logger = this.logger;
959
+ const request = yield oci_common_1.composeRequest({
960
+ baseEndpoint: this._endpoint,
961
+ defaultHeaders: this._defaultHeaders,
962
+ path: "/consumerGroups",
963
+ method: "POST",
964
+ bodyContent: common.ObjectSerializer.serialize(createConsumerGroupRequest.createConsumerGroupDetails, "CreateConsumerGroupDetails", model.CreateConsumerGroupDetails.getJsonObj),
965
+ pathParams: pathParams,
966
+ headerParams: headerParams,
967
+ queryParams: queryParams
968
+ });
969
+ try {
970
+ const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
971
+ const sdkResponse = oci_common_1.composeResponse({
972
+ responseObject: {},
973
+ responseHeaders: [
974
+ {
975
+ value: response.headers.get("opc-work-request-id"),
976
+ key: "opcWorkRequestId",
977
+ dataType: "string"
978
+ },
979
+ {
980
+ value: response.headers.get("opc-request-id"),
981
+ key: "opcRequestId",
982
+ dataType: "string"
983
+ }
984
+ ]
985
+ });
986
+ return sdkResponse;
987
+ }
988
+ catch (err) {
989
+ throw err;
990
+ }
991
+ });
992
+ }
922
993
  /**
923
994
  * Creates a new queue.
924
995
  *
@@ -979,6 +1050,66 @@ class QueueAdminClient {
979
1050
  }
980
1051
  });
981
1052
  }
1053
+ /**
1054
+ * Deletes a consumer group resource by identifier.
1055
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
1056
+ * @param DeleteConsumerGroupRequest
1057
+ * @return DeleteConsumerGroupResponse
1058
+ * @throws OciError when an error occurs
1059
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/queue/DeleteConsumerGroup.ts.html |here} to see how to use DeleteConsumerGroup API.
1060
+ */
1061
+ deleteConsumerGroup(deleteConsumerGroupRequest) {
1062
+ return __awaiter(this, void 0, void 0, function* () {
1063
+ if (this.logger)
1064
+ this.logger.debug("Calling operation QueueAdminClient#deleteConsumerGroup.");
1065
+ const operationName = "deleteConsumerGroup";
1066
+ const apiReferenceLink = "";
1067
+ const pathParams = {
1068
+ "{consumerGroupId}": deleteConsumerGroupRequest.consumerGroupId
1069
+ };
1070
+ const queryParams = {};
1071
+ let headerParams = {
1072
+ "Content-Type": common.Constants.APPLICATION_JSON,
1073
+ "if-match": deleteConsumerGroupRequest.ifMatch,
1074
+ "opc-request-id": deleteConsumerGroupRequest.opcRequestId
1075
+ };
1076
+ const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
1077
+ const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, deleteConsumerGroupRequest.retryConfiguration, specRetryConfiguration);
1078
+ if (this.logger)
1079
+ retrier.logger = this.logger;
1080
+ const request = yield oci_common_1.composeRequest({
1081
+ baseEndpoint: this._endpoint,
1082
+ defaultHeaders: this._defaultHeaders,
1083
+ path: "/consumerGroups/{consumerGroupId}",
1084
+ method: "DELETE",
1085
+ pathParams: pathParams,
1086
+ headerParams: headerParams,
1087
+ queryParams: queryParams
1088
+ });
1089
+ try {
1090
+ const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
1091
+ const sdkResponse = oci_common_1.composeResponse({
1092
+ responseObject: {},
1093
+ responseHeaders: [
1094
+ {
1095
+ value: response.headers.get("opc-work-request-id"),
1096
+ key: "opcWorkRequestId",
1097
+ dataType: "string"
1098
+ },
1099
+ {
1100
+ value: response.headers.get("opc-request-id"),
1101
+ key: "opcRequestId",
1102
+ dataType: "string"
1103
+ }
1104
+ ]
1105
+ });
1106
+ return sdkResponse;
1107
+ }
1108
+ catch (err) {
1109
+ throw err;
1110
+ }
1111
+ });
1112
+ }
982
1113
  /**
983
1114
  * Deletes a queue resource by identifier.
984
1115
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
@@ -1039,6 +1170,69 @@ class QueueAdminClient {
1039
1170
  }
1040
1171
  });
1041
1172
  }
1173
+ /**
1174
+ * Gets a consumer group by identifier.
1175
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
1176
+ * @param GetConsumerGroupRequest
1177
+ * @return GetConsumerGroupResponse
1178
+ * @throws OciError when an error occurs
1179
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/queue/GetConsumerGroup.ts.html |here} to see how to use GetConsumerGroup API.
1180
+ */
1181
+ getConsumerGroup(getConsumerGroupRequest) {
1182
+ return __awaiter(this, void 0, void 0, function* () {
1183
+ if (this.logger)
1184
+ this.logger.debug("Calling operation QueueAdminClient#getConsumerGroup.");
1185
+ const operationName = "getConsumerGroup";
1186
+ const apiReferenceLink = "";
1187
+ const pathParams = {
1188
+ "{consumerGroupId}": getConsumerGroupRequest.consumerGroupId
1189
+ };
1190
+ const queryParams = {};
1191
+ let headerParams = {
1192
+ "Content-Type": common.Constants.APPLICATION_JSON,
1193
+ "opc-request-id": getConsumerGroupRequest.opcRequestId
1194
+ };
1195
+ const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
1196
+ const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, getConsumerGroupRequest.retryConfiguration, specRetryConfiguration);
1197
+ if (this.logger)
1198
+ retrier.logger = this.logger;
1199
+ const request = yield oci_common_1.composeRequest({
1200
+ baseEndpoint: this._endpoint,
1201
+ defaultHeaders: this._defaultHeaders,
1202
+ path: "/consumerGroups/{consumerGroupId}",
1203
+ method: "GET",
1204
+ pathParams: pathParams,
1205
+ headerParams: headerParams,
1206
+ queryParams: queryParams
1207
+ });
1208
+ try {
1209
+ const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
1210
+ const sdkResponse = oci_common_1.composeResponse({
1211
+ responseObject: {},
1212
+ body: yield response.json(),
1213
+ bodyKey: "consumerGroup",
1214
+ bodyModel: model.ConsumerGroup,
1215
+ type: "model.ConsumerGroup",
1216
+ responseHeaders: [
1217
+ {
1218
+ value: response.headers.get("etag"),
1219
+ key: "etag",
1220
+ dataType: "string"
1221
+ },
1222
+ {
1223
+ value: response.headers.get("opc-request-id"),
1224
+ key: "opcRequestId",
1225
+ dataType: "string"
1226
+ }
1227
+ ]
1228
+ });
1229
+ return sdkResponse;
1230
+ }
1231
+ catch (err) {
1232
+ throw err;
1233
+ }
1234
+ });
1235
+ }
1042
1236
  /**
1043
1237
  * Gets a queue by identifier.
1044
1238
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
@@ -1165,6 +1359,77 @@ class QueueAdminClient {
1165
1359
  }
1166
1360
  });
1167
1361
  }
1362
+ /**
1363
+ * Returns a list of consumer groups.
1364
+ *
1365
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
1366
+ * @param ListConsumerGroupsRequest
1367
+ * @return ListConsumerGroupsResponse
1368
+ * @throws OciError when an error occurs
1369
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/queue/ListConsumerGroups.ts.html |here} to see how to use ListConsumerGroups API.
1370
+ */
1371
+ listConsumerGroups(listConsumerGroupsRequest) {
1372
+ return __awaiter(this, void 0, void 0, function* () {
1373
+ if (this.logger)
1374
+ this.logger.debug("Calling operation QueueAdminClient#listConsumerGroups.");
1375
+ const operationName = "listConsumerGroups";
1376
+ const apiReferenceLink = "";
1377
+ const pathParams = {};
1378
+ const queryParams = {
1379
+ "lifecycleState": listConsumerGroupsRequest.lifecycleState,
1380
+ "displayName": listConsumerGroupsRequest.displayName,
1381
+ "id": listConsumerGroupsRequest.id,
1382
+ "queueId": listConsumerGroupsRequest.queueId,
1383
+ "limit": listConsumerGroupsRequest.limit,
1384
+ "page": listConsumerGroupsRequest.page,
1385
+ "sortOrder": listConsumerGroupsRequest.sortOrder,
1386
+ "sortBy": listConsumerGroupsRequest.sortBy
1387
+ };
1388
+ let headerParams = {
1389
+ "Content-Type": common.Constants.APPLICATION_JSON,
1390
+ "opc-request-id": listConsumerGroupsRequest.opcRequestId
1391
+ };
1392
+ const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
1393
+ const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, listConsumerGroupsRequest.retryConfiguration, specRetryConfiguration);
1394
+ if (this.logger)
1395
+ retrier.logger = this.logger;
1396
+ const request = yield oci_common_1.composeRequest({
1397
+ baseEndpoint: this._endpoint,
1398
+ defaultHeaders: this._defaultHeaders,
1399
+ path: "/consumerGroups",
1400
+ method: "GET",
1401
+ pathParams: pathParams,
1402
+ headerParams: headerParams,
1403
+ queryParams: queryParams
1404
+ });
1405
+ try {
1406
+ const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
1407
+ const sdkResponse = oci_common_1.composeResponse({
1408
+ responseObject: {},
1409
+ body: yield response.json(),
1410
+ bodyKey: "consumerGroupCollection",
1411
+ bodyModel: model.ConsumerGroupCollection,
1412
+ type: "model.ConsumerGroupCollection",
1413
+ responseHeaders: [
1414
+ {
1415
+ value: response.headers.get("opc-request-id"),
1416
+ key: "opcRequestId",
1417
+ dataType: "string"
1418
+ },
1419
+ {
1420
+ value: response.headers.get("opc-next-page"),
1421
+ key: "opcNextPage",
1422
+ dataType: "string"
1423
+ }
1424
+ ]
1425
+ });
1426
+ return sdkResponse;
1427
+ }
1428
+ catch (err) {
1429
+ throw err;
1430
+ }
1431
+ });
1432
+ }
1168
1433
  /**
1169
1434
  * Returns a list of queues.
1170
1435
  *
@@ -1438,9 +1703,12 @@ class QueueAdminClient {
1438
1703
  });
1439
1704
  }
1440
1705
  /**
1441
- * Deletes all messages present in the queue, or deletes all the messages in the specific channel at the time of invocation. Only one concurrent purge operation is supported for any given queue.
1706
+ * Deletes all messages present in the queue or in the specified consumer group, or deletes all the messages in the specific channel at the time of invocation.
1707
+ * Only one concurrent purge operation is supported for any given queue.
1442
1708
  * However multiple concurrent purge operations are supported for different queues.
1443
1709
  * Purge request without specification of target channels will clean up all messages in the queue and in the child channels.
1710
+ * Purge request without specification of consumer group will either clean up all messages in the queue or in the primary consumer group, depending on the presence of the CONSUMER_GROUPS capability on the queue.
1711
+ * To purge all consumer groups, the special value 'all' can be used.
1444
1712
  *
1445
1713
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
1446
1714
  * @param PurgeQueueRequest
@@ -1501,6 +1769,67 @@ class QueueAdminClient {
1501
1769
  }
1502
1770
  });
1503
1771
  }
1772
+ /**
1773
+ * Updates the specified consumer group.
1774
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
1775
+ * @param UpdateConsumerGroupRequest
1776
+ * @return UpdateConsumerGroupResponse
1777
+ * @throws OciError when an error occurs
1778
+ * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/queue/UpdateConsumerGroup.ts.html |here} to see how to use UpdateConsumerGroup API.
1779
+ */
1780
+ updateConsumerGroup(updateConsumerGroupRequest) {
1781
+ return __awaiter(this, void 0, void 0, function* () {
1782
+ if (this.logger)
1783
+ this.logger.debug("Calling operation QueueAdminClient#updateConsumerGroup.");
1784
+ const operationName = "updateConsumerGroup";
1785
+ const apiReferenceLink = "";
1786
+ const pathParams = {
1787
+ "{consumerGroupId}": updateConsumerGroupRequest.consumerGroupId
1788
+ };
1789
+ const queryParams = {};
1790
+ let headerParams = {
1791
+ "Content-Type": common.Constants.APPLICATION_JSON,
1792
+ "if-match": updateConsumerGroupRequest.ifMatch,
1793
+ "opc-request-id": updateConsumerGroupRequest.opcRequestId
1794
+ };
1795
+ const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
1796
+ const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, updateConsumerGroupRequest.retryConfiguration, specRetryConfiguration);
1797
+ if (this.logger)
1798
+ retrier.logger = this.logger;
1799
+ const request = yield oci_common_1.composeRequest({
1800
+ baseEndpoint: this._endpoint,
1801
+ defaultHeaders: this._defaultHeaders,
1802
+ path: "/consumerGroups/{consumerGroupId}",
1803
+ method: "PUT",
1804
+ bodyContent: common.ObjectSerializer.serialize(updateConsumerGroupRequest.updateConsumerGroupDetails, "UpdateConsumerGroupDetails", model.UpdateConsumerGroupDetails.getJsonObj),
1805
+ pathParams: pathParams,
1806
+ headerParams: headerParams,
1807
+ queryParams: queryParams
1808
+ });
1809
+ try {
1810
+ const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
1811
+ const sdkResponse = oci_common_1.composeResponse({
1812
+ responseObject: {},
1813
+ responseHeaders: [
1814
+ {
1815
+ value: response.headers.get("opc-work-request-id"),
1816
+ key: "opcWorkRequestId",
1817
+ dataType: "string"
1818
+ },
1819
+ {
1820
+ value: response.headers.get("opc-request-id"),
1821
+ key: "opcRequestId",
1822
+ dataType: "string"
1823
+ }
1824
+ ]
1825
+ });
1826
+ return sdkResponse;
1827
+ }
1828
+ catch (err) {
1829
+ throw err;
1830
+ }
1831
+ });
1832
+ }
1504
1833
  /**
1505
1834
  * Updates the specified queue.
1506
1835
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.