oci-queue 2.69.0 → 2.70.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (131) hide show
  1. package/index.d.ts +1 -1
  2. package/index.js +1 -1
  3. package/lib/client.d.ts +67 -29
  4. package/lib/client.js +130 -31
  5. package/lib/client.js.map +1 -1
  6. package/lib/model/action-type.d.ts +1 -1
  7. package/lib/model/action-type.js +1 -1
  8. package/lib/model/change-queue-compartment-details.d.ts +1 -1
  9. package/lib/model/change-queue-compartment-details.js +1 -1
  10. package/lib/model/channel-collection.d.ts +25 -0
  11. package/lib/model/channel-collection.js +29 -0
  12. package/lib/model/channel-collection.js.map +1 -0
  13. package/lib/model/create-queue-details.d.ts +11 -7
  14. package/lib/model/create-queue-details.js +1 -1
  15. package/lib/model/create-queue-details.js.map +1 -1
  16. package/lib/model/delete-messages-details-entry.d.ts +2 -2
  17. package/lib/model/delete-messages-details-entry.js +1 -1
  18. package/lib/model/delete-messages-details.d.ts +1 -1
  19. package/lib/model/delete-messages-details.js +1 -1
  20. package/lib/model/delete-messages-result-entry.d.ts +1 -1
  21. package/lib/model/delete-messages-result-entry.js +1 -1
  22. package/lib/model/delete-messages-result.d.ts +1 -1
  23. package/lib/model/delete-messages-result.js +1 -1
  24. package/lib/model/get-message.d.ts +16 -8
  25. package/lib/model/get-message.js +29 -3
  26. package/lib/model/get-message.js.map +1 -1
  27. package/lib/model/get-messages.d.ts +1 -1
  28. package/lib/model/get-messages.js +1 -1
  29. package/lib/model/index.d.ts +5 -1
  30. package/lib/model/index.js +6 -2
  31. package/lib/model/index.js.map +1 -1
  32. package/lib/model/message-metadata.d.ts +31 -0
  33. package/lib/model/message-metadata.js +29 -0
  34. package/lib/model/message-metadata.js.map +1 -0
  35. package/lib/model/operation-status.d.ts +1 -1
  36. package/lib/model/operation-status.js +1 -1
  37. package/lib/model/operation-type.d.ts +1 -1
  38. package/lib/model/operation-type.js +1 -1
  39. package/lib/model/purge-queue-details.d.ts +11 -4
  40. package/lib/model/purge-queue-details.js +1 -1
  41. package/lib/model/purge-queue-details.js.map +1 -1
  42. package/lib/model/put-message.d.ts +10 -3
  43. package/lib/model/put-message.js +1 -1
  44. package/lib/model/put-message.js.map +1 -1
  45. package/lib/model/put-messages-details-entry.d.ts +3 -1
  46. package/lib/model/put-messages-details-entry.js +29 -3
  47. package/lib/model/put-messages-details-entry.js.map +1 -1
  48. package/lib/model/put-messages-details.d.ts +1 -1
  49. package/lib/model/put-messages-details.js +1 -1
  50. package/lib/model/put-messages.d.ts +3 -3
  51. package/lib/model/put-messages.js +1 -1
  52. package/lib/model/queue-collection.d.ts +1 -1
  53. package/lib/model/queue-collection.js +1 -1
  54. package/lib/model/queue-stats.d.ts +6 -2
  55. package/lib/model/queue-stats.js +1 -1
  56. package/lib/model/queue-stats.js.map +1 -1
  57. package/lib/model/queue-summary.d.ts +18 -12
  58. package/lib/model/queue-summary.js +1 -1
  59. package/lib/model/queue-summary.js.map +1 -1
  60. package/lib/model/queue.d.ts +23 -13
  61. package/lib/model/queue.js +1 -1
  62. package/lib/model/queue.js.map +1 -1
  63. package/lib/model/sort-order.d.ts +1 -1
  64. package/lib/model/sort-order.js +1 -1
  65. package/lib/model/stats.d.ts +2 -2
  66. package/lib/model/stats.js +1 -1
  67. package/lib/model/update-message-details.d.ts +1 -1
  68. package/lib/model/update-message-details.js +1 -1
  69. package/lib/model/update-messages-details-entry.d.ts +2 -2
  70. package/lib/model/update-messages-details-entry.js +1 -1
  71. package/lib/model/update-messages-details.d.ts +2 -2
  72. package/lib/model/update-messages-details.js +1 -1
  73. package/lib/model/update-messages-result-entry.d.ts +7 -4
  74. package/lib/model/update-messages-result-entry.js +1 -1
  75. package/lib/model/update-messages-result-entry.js.map +1 -1
  76. package/lib/model/update-messages-result.d.ts +2 -2
  77. package/lib/model/update-messages-result.js +1 -1
  78. package/lib/model/update-queue-details.d.ts +9 -5
  79. package/lib/model/update-queue-details.js +1 -1
  80. package/lib/model/update-queue-details.js.map +1 -1
  81. package/lib/model/updated-message.d.ts +7 -4
  82. package/lib/model/updated-message.js +1 -1
  83. package/lib/model/updated-message.js.map +1 -1
  84. package/lib/model/work-request-error-collection.d.ts +1 -1
  85. package/lib/model/work-request-error-collection.js +1 -1
  86. package/lib/model/work-request-error.d.ts +2 -2
  87. package/lib/model/work-request-error.js +1 -1
  88. package/lib/model/work-request-log-entry-collection.d.ts +1 -1
  89. package/lib/model/work-request-log-entry-collection.js +1 -1
  90. package/lib/model/work-request-log-entry.d.ts +2 -2
  91. package/lib/model/work-request-log-entry.js +1 -1
  92. package/lib/model/work-request-resource.d.ts +1 -1
  93. package/lib/model/work-request-resource.js +1 -1
  94. package/lib/model/work-request-summary-collection.d.ts +1 -1
  95. package/lib/model/work-request-summary-collection.js +1 -1
  96. package/lib/model/work-request-summary.d.ts +3 -3
  97. package/lib/model/work-request-summary.js +1 -1
  98. package/lib/model/work-request.d.ts +2 -2
  99. package/lib/model/work-request.js +1 -1
  100. package/lib/queueadmin-waiter.d.ts +1 -1
  101. package/lib/queueadmin-waiter.js +1 -1
  102. package/lib/request/change-queue-compartment-request.d.ts +3 -3
  103. package/lib/request/create-queue-request.d.ts +2 -2
  104. package/lib/request/delete-message-request.d.ts +3 -3
  105. package/lib/request/delete-messages-request.d.ts +3 -3
  106. package/lib/request/delete-queue-request.d.ts +3 -3
  107. package/lib/request/get-messages-request.d.ts +20 -16
  108. package/lib/request/get-queue-request.d.ts +3 -3
  109. package/lib/request/get-stats-request.d.ts +7 -3
  110. package/lib/request/get-work-request-request.d.ts +2 -2
  111. package/lib/request/index.d.ts +3 -1
  112. package/lib/request/index.js +1 -1
  113. package/lib/request/index.js.map +1 -1
  114. package/lib/request/list-channels-request.d.ts +38 -0
  115. package/lib/request/list-channels-request.js +15 -0
  116. package/lib/request/list-channels-request.js.map +1 -0
  117. package/lib/request/list-queues-request.d.ts +6 -6
  118. package/lib/request/list-work-request-errors-request.d.ts +4 -4
  119. package/lib/request/list-work-request-logs-request.d.ts +4 -4
  120. package/lib/request/list-work-requests-request.d.ts +5 -5
  121. package/lib/request/purge-queue-request.d.ts +3 -3
  122. package/lib/request/put-messages-request.d.ts +3 -3
  123. package/lib/request/update-message-request.d.ts +3 -3
  124. package/lib/request/update-messages-request.d.ts +3 -3
  125. package/lib/request/update-queue-request.d.ts +3 -3
  126. package/lib/response/index.d.ts +3 -1
  127. package/lib/response/index.js +1 -1
  128. package/lib/response/list-channels-response.d.ts +32 -0
  129. package/lib/response/list-channels-response.js +15 -0
  130. package/lib/response/list-channels-response.js.map +1 -0
  131. package/package.json +3 -3
package/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Queue API
3
- * A description of the Queue API
3
+ * Use the Queue API to produce and consume messages, create queues, and manage related items. For more information, see [Queue](/iaas/Content/queue/overview.htm).
4
4
  * OpenAPI spec version: 20210201
5
5
  *
6
6
  *
package/index.js CHANGED
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
3
  * Queue API
4
- * A description of the Queue API
4
+ * Use the Queue API to produce and consume messages, create queues, and manage related items. For more information, see [Queue](/iaas/Content/queue/overview.htm).
5
5
  * OpenAPI spec version: 20210201
6
6
  *
7
7
  *
package/lib/client.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Queue API
3
- * A description of the Queue API
3
+ * Use the Queue API to produce and consume messages, create queues, and manage related items. For more information, see [Queue](/iaas/Content/queue/overview.htm).
4
4
  * OpenAPI spec version: 20210201
5
5
  *
6
6
  *
@@ -67,66 +67,103 @@ export declare class QueueClient {
67
67
  */
68
68
  set regionId(regionId: string);
69
69
  /**
70
- * Deletes from the queue the message represented by the receipt.
70
+ * Deletes the message represented by the receipt from the queue.
71
+ * You must use the [messages endpoint](https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to delete messages.
72
+ * The messages endpoint may be different for different queues. Use {@link #getQueue(GetQueueRequest) getQueue} to find the queue's `messagesEndpoint`.
73
+ *
71
74
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
72
75
  * @param DeleteMessageRequest
73
76
  * @return DeleteMessageResponse
74
77
  * @throws OciError when an error occurs
75
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/DeleteMessage.ts.html |here} to see how to use DeleteMessage API.
78
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/DeleteMessage.ts.html |here} to see how to use DeleteMessage API.
76
79
  */
77
80
  deleteMessage(deleteMessageRequest: requests.DeleteMessageRequest): Promise<responses.DeleteMessageResponse>;
78
81
  /**
79
82
  * Deletes multiple messages from the queue.
83
+ * You must use the [messages endpoint](https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to delete messages.
84
+ * The messages endpoint may be different for different queues. Use {@link #getQueue(GetQueueRequest) getQueue} to find the queue's `messagesEndpoint`.
85
+ *
80
86
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
81
87
  * @param DeleteMessagesRequest
82
88
  * @return DeleteMessagesResponse
83
89
  * @throws OciError when an error occurs
84
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/DeleteMessages.ts.html |here} to see how to use DeleteMessages API.
90
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/DeleteMessages.ts.html |here} to see how to use DeleteMessages API.
85
91
  */
86
92
  deleteMessages(deleteMessagesRequest: requests.DeleteMessagesRequest): Promise<responses.DeleteMessagesResponse>;
87
93
  /**
88
- * Consumes message from the queue.
94
+ * Consumes messages from the queue.
95
+ * You must use the [messages endpoint](https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to consume messages.
96
+ * The messages endpoint may be different for different queues. Use {@link #getQueue(GetQueueRequest) getQueue} to find the queue's `messagesEndpoint`.
97
+ * GetMessages accepts optional channelFilter query parameter that can filter source channels of the messages.
98
+ * When channelFilter is present, service will return available messages from the channel which ID exactly matched the filter.
99
+ * When filter is not specified, messages will be returned from a random non-empty channel within a queue.
100
+ *
89
101
  * This operation does not retry by default if the user has not defined a retry configuration.
90
102
  * @param GetMessagesRequest
91
103
  * @return GetMessagesResponse
92
104
  * @throws OciError when an error occurs
93
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/GetMessages.ts.html |here} to see how to use GetMessages API.
105
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/GetMessages.ts.html |here} to see how to use GetMessages API.
94
106
  */
95
107
  getMessages(getMessagesRequest: requests.GetMessagesRequest): Promise<responses.GetMessagesResponse>;
96
108
  /**
97
109
  * Gets the statistics for the queue and its dead letter queue.
110
+ * You must use the [messages endpoint](https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to get a queue's statistics.
111
+ * The messages endpoint may be different for different queues. Use {@link #getQueue(GetQueueRequest) getQueue} to find the queue's `messagesEndpoint`.
112
+ *
98
113
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
99
114
  * @param GetStatsRequest
100
115
  * @return GetStatsResponse
101
116
  * @throws OciError when an error occurs
102
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/GetStats.ts.html |here} to see how to use GetStats API.
117
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/GetStats.ts.html |here} to see how to use GetStats API.
103
118
  */
104
119
  getStats(getStatsRequest: requests.GetStatsRequest): Promise<responses.GetStatsResponse>;
105
120
  /**
106
- * Puts messages in the queue
121
+ * Gets the list of IDs of non-empty channels.
122
+ * It will return an approximate list of IDs of non-empty channels. That information is based on the queue level statistics.
123
+ * API supports optional channelFilter parameter which will filter the returned results according to the specified filter.
124
+ * List of channel IDs is approximate, because statistics is refreshed once per-second, and that list represents a snapshot of the past information. API is paginated.
125
+ *
126
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
127
+ * @param ListChannelsRequest
128
+ * @return ListChannelsResponse
129
+ * @throws OciError when an error occurs
130
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/ListChannels.ts.html |here} to see how to use ListChannels API.
131
+ */
132
+ listChannels(listChannelsRequest: requests.ListChannelsRequest): Promise<responses.ListChannelsResponse>;
133
+ /**
134
+ * Puts messages into the queue.
135
+ * You must use the [messages endpoint](https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to produce messages.
136
+ * The messages endpoint may be different for different queues. Use {@link #getQueue(GetQueueRequest) getQueue} to find the queue's `messagesEndpoint`.
137
+ *
107
138
  * This operation does not retry by default if the user has not defined a retry configuration.
108
139
  * @param PutMessagesRequest
109
140
  * @return PutMessagesResponse
110
141
  * @throws OciError when an error occurs
111
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/PutMessages.ts.html |here} to see how to use PutMessages API.
142
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/PutMessages.ts.html |here} to see how to use PutMessages API.
112
143
  */
113
144
  putMessages(putMessagesRequest: requests.PutMessagesRequest): Promise<responses.PutMessagesResponse>;
114
145
  /**
115
146
  * Updates the visibility of the message represented by the receipt.
147
+ * You must use the [messages endpoint](https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to update messages.
148
+ * The messages endpoint may be different for different queues. Use {@link #getQueue(GetQueueRequest) getQueue} to find the queue's `messagesEndpoint`.
149
+ *
116
150
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
117
151
  * @param UpdateMessageRequest
118
152
  * @return UpdateMessageResponse
119
153
  * @throws OciError when an error occurs
120
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/UpdateMessage.ts.html |here} to see how to use UpdateMessage API.
154
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/UpdateMessage.ts.html |here} to see how to use UpdateMessage API.
121
155
  */
122
156
  updateMessage(updateMessageRequest: requests.UpdateMessageRequest): Promise<responses.UpdateMessageResponse>;
123
157
  /**
124
158
  * Updates multiple messages in the queue.
159
+ * You must use the [messages endpoint](https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to update messages.
160
+ * The messages endpoint may be different for different queues. Use {@link #getQueue(GetQueueRequest) getQueue} to find the queue's `messagesEndpoint`.
161
+ *
125
162
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
126
163
  * @param UpdateMessagesRequest
127
164
  * @return UpdateMessagesResponse
128
165
  * @throws OciError when an error occurs
129
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/UpdateMessages.ts.html |here} to see how to use UpdateMessages API.
166
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/UpdateMessages.ts.html |here} to see how to use UpdateMessages API.
130
167
  */
131
168
  updateMessages(updateMessagesRequest: requests.UpdateMessagesRequest): Promise<responses.UpdateMessagesResponse>;
132
169
  }
@@ -197,40 +234,40 @@ export declare class QueueAdminClient {
197
234
  */
198
235
  getWaiters(): QueueAdminWaiter;
199
236
  /**
200
- * Moves a Queue resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
237
+ * Moves a queue from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
201
238
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
202
239
  * @param ChangeQueueCompartmentRequest
203
240
  * @return ChangeQueueCompartmentResponse
204
241
  * @throws OciError when an error occurs
205
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/ChangeQueueCompartment.ts.html |here} to see how to use ChangeQueueCompartment API.
242
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/ChangeQueueCompartment.ts.html |here} to see how to use ChangeQueueCompartment API.
206
243
  */
207
244
  changeQueueCompartment(changeQueueCompartmentRequest: requests.ChangeQueueCompartmentRequest): Promise<responses.ChangeQueueCompartmentResponse>;
208
245
  /**
209
- * Creates a new Queue.
246
+ * Creates a new queue.
210
247
  *
211
248
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
212
249
  * @param CreateQueueRequest
213
250
  * @return CreateQueueResponse
214
251
  * @throws OciError when an error occurs
215
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/CreateQueue.ts.html |here} to see how to use CreateQueue API.
252
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/CreateQueue.ts.html |here} to see how to use CreateQueue API.
216
253
  */
217
254
  createQueue(createQueueRequest: requests.CreateQueueRequest): Promise<responses.CreateQueueResponse>;
218
255
  /**
219
- * Deletes a Queue resource by identifier
256
+ * Deletes a queue resource by identifier.
220
257
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
221
258
  * @param DeleteQueueRequest
222
259
  * @return DeleteQueueResponse
223
260
  * @throws OciError when an error occurs
224
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/DeleteQueue.ts.html |here} to see how to use DeleteQueue API.
261
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/DeleteQueue.ts.html |here} to see how to use DeleteQueue API.
225
262
  */
226
263
  deleteQueue(deleteQueueRequest: requests.DeleteQueueRequest): Promise<responses.DeleteQueueResponse>;
227
264
  /**
228
- * Gets a Queue by identifier
265
+ * Gets a queue by identifier.
229
266
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
230
267
  * @param GetQueueRequest
231
268
  * @return GetQueueResponse
232
269
  * @throws OciError when an error occurs
233
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/GetQueue.ts.html |here} to see how to use GetQueue API.
270
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/GetQueue.ts.html |here} to see how to use GetQueue API.
234
271
  */
235
272
  getQueue(getQueueRequest: requests.GetQueueRequest): Promise<responses.GetQueueResponse>;
236
273
  /**
@@ -239,17 +276,17 @@ export declare class QueueAdminClient {
239
276
  * @param GetWorkRequestRequest
240
277
  * @return GetWorkRequestResponse
241
278
  * @throws OciError when an error occurs
242
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
279
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
243
280
  */
244
281
  getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
245
282
  /**
246
- * Returns a list of Queues.
283
+ * Returns a list of queues.
247
284
  *
248
285
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
249
286
  * @param ListQueuesRequest
250
287
  * @return ListQueuesResponse
251
288
  * @throws OciError when an error occurs
252
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/ListQueues.ts.html |here} to see how to use ListQueues API.
289
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/ListQueues.ts.html |here} to see how to use ListQueues API.
253
290
  */
254
291
  listQueues(listQueuesRequest: requests.ListQueuesRequest): Promise<responses.ListQueuesResponse>;
255
292
  /**
@@ -259,7 +296,7 @@ export declare class QueueAdminClient {
259
296
  * @param ListWorkRequestErrorsRequest
260
297
  * @return ListWorkRequestErrorsResponse
261
298
  * @throws OciError when an error occurs
262
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
299
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
263
300
  */
264
301
  listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
265
302
  /**
@@ -269,7 +306,7 @@ export declare class QueueAdminClient {
269
306
  * @param ListWorkRequestLogsRequest
270
307
  * @return ListWorkRequestLogsResponse
271
308
  * @throws OciError when an error occurs
272
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
309
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
273
310
  */
274
311
  listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
275
312
  /**
@@ -279,27 +316,28 @@ export declare class QueueAdminClient {
279
316
  * @param ListWorkRequestsRequest
280
317
  * @return ListWorkRequestsResponse
281
318
  * @throws OciError when an error occurs
282
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
319
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
283
320
  */
284
321
  listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
285
322
  /**
286
- * Deletes all messages present in the queue at the time of invocation. Only one concurrent purge operation is supported for any given queue.
323
+ * 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.
287
324
  * However multiple concurrent purge operations are supported for different queues.
325
+ * Purge request without specification of target channels will clean up all messages in the queue and in the child channels.
288
326
  *
289
327
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
290
328
  * @param PurgeQueueRequest
291
329
  * @return PurgeQueueResponse
292
330
  * @throws OciError when an error occurs
293
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/PurgeQueue.ts.html |here} to see how to use PurgeQueue API.
331
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/PurgeQueue.ts.html |here} to see how to use PurgeQueue API.
294
332
  */
295
333
  purgeQueue(purgeQueueRequest: requests.PurgeQueueRequest): Promise<responses.PurgeQueueResponse>;
296
334
  /**
297
- * Updates the Queue
335
+ * Updates the specified queue.
298
336
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
299
337
  * @param UpdateQueueRequest
300
338
  * @return UpdateQueueResponse
301
339
  * @throws OciError when an error occurs
302
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/UpdateQueue.ts.html |here} to see how to use UpdateQueue API.
340
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/UpdateQueue.ts.html |here} to see how to use UpdateQueue API.
303
341
  */
304
342
  updateQueue(updateQueueRequest: requests.UpdateQueueRequest): Promise<responses.UpdateQueueResponse>;
305
343
  }
package/lib/client.js CHANGED
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
3
  * Queue API
4
- * A description of the Queue API
4
+ * Use the Queue API to produce and consume messages, create queues, and manage related items. For more information, see [Queue](/iaas/Content/queue/overview.htm).
5
5
  * OpenAPI spec version: 20210201
6
6
  *
7
7
  *
@@ -157,12 +157,15 @@ class QueueClient {
157
157
  this._lastSetRegionOrRegionId = common.Region.REGION_ID_STRING;
158
158
  }
159
159
  /**
160
- * Deletes from the queue the message represented by the receipt.
160
+ * Deletes the message represented by the receipt from the queue.
161
+ * You must use the [messages endpoint](https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to delete messages.
162
+ * The messages endpoint may be different for different queues. Use {@link #getQueue(GetQueueRequest) getQueue} to find the queue's `messagesEndpoint`.
163
+ *
161
164
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
162
165
  * @param DeleteMessageRequest
163
166
  * @return DeleteMessageResponse
164
167
  * @throws OciError when an error occurs
165
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/DeleteMessage.ts.html |here} to see how to use DeleteMessage API.
168
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/DeleteMessage.ts.html |here} to see how to use DeleteMessage API.
166
169
  */
167
170
  deleteMessage(deleteMessageRequest) {
168
171
  return __awaiter(this, void 0, void 0, function* () {
@@ -213,11 +216,14 @@ class QueueClient {
213
216
  }
214
217
  /**
215
218
  * Deletes multiple messages from the queue.
219
+ * You must use the [messages endpoint](https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to delete messages.
220
+ * The messages endpoint may be different for different queues. Use {@link #getQueue(GetQueueRequest) getQueue} to find the queue's `messagesEndpoint`.
221
+ *
216
222
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
217
223
  * @param DeleteMessagesRequest
218
224
  * @return DeleteMessagesResponse
219
225
  * @throws OciError when an error occurs
220
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/DeleteMessages.ts.html |here} to see how to use DeleteMessages API.
226
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/DeleteMessages.ts.html |here} to see how to use DeleteMessages API.
221
227
  */
222
228
  deleteMessages(deleteMessagesRequest) {
223
229
  return __awaiter(this, void 0, void 0, function* () {
@@ -271,12 +277,18 @@ class QueueClient {
271
277
  });
272
278
  }
273
279
  /**
274
- * Consumes message from the queue.
280
+ * Consumes messages from the queue.
281
+ * You must use the [messages endpoint](https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to consume messages.
282
+ * The messages endpoint may be different for different queues. Use {@link #getQueue(GetQueueRequest) getQueue} to find the queue's `messagesEndpoint`.
283
+ * GetMessages accepts optional channelFilter query parameter that can filter source channels of the messages.
284
+ * When channelFilter is present, service will return available messages from the channel which ID exactly matched the filter.
285
+ * When filter is not specified, messages will be returned from a random non-empty channel within a queue.
286
+ *
275
287
  * This operation does not retry by default if the user has not defined a retry configuration.
276
288
  * @param GetMessagesRequest
277
289
  * @return GetMessagesResponse
278
290
  * @throws OciError when an error occurs
279
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/GetMessages.ts.html |here} to see how to use GetMessages API.
291
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/GetMessages.ts.html |here} to see how to use GetMessages API.
280
292
  */
281
293
  getMessages(getMessagesRequest) {
282
294
  return __awaiter(this, void 0, void 0, function* () {
@@ -290,7 +302,8 @@ class QueueClient {
290
302
  const queryParams = {
291
303
  "visibilityInSeconds": getMessagesRequest.visibilityInSeconds,
292
304
  "timeoutInSeconds": getMessagesRequest.timeoutInSeconds,
293
- "limit": getMessagesRequest.limit
305
+ "limit": getMessagesRequest.limit,
306
+ "channelFilter": getMessagesRequest.channelFilter
294
307
  };
295
308
  let headerParams = {
296
309
  "Content-Type": common.Constants.APPLICATION_JSON,
@@ -334,11 +347,14 @@ class QueueClient {
334
347
  }
335
348
  /**
336
349
  * Gets the statistics for the queue and its dead letter queue.
350
+ * You must use the [messages endpoint](https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to get a queue's statistics.
351
+ * The messages endpoint may be different for different queues. Use {@link #getQueue(GetQueueRequest) getQueue} to find the queue's `messagesEndpoint`.
352
+ *
337
353
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
338
354
  * @param GetStatsRequest
339
355
  * @return GetStatsResponse
340
356
  * @throws OciError when an error occurs
341
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/GetStats.ts.html |here} to see how to use GetStats API.
357
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/GetStats.ts.html |here} to see how to use GetStats API.
342
358
  */
343
359
  getStats(getStatsRequest) {
344
360
  return __awaiter(this, void 0, void 0, function* () {
@@ -349,7 +365,9 @@ class QueueClient {
349
365
  const pathParams = {
350
366
  "{queueId}": getStatsRequest.queueId
351
367
  };
352
- const queryParams = {};
368
+ const queryParams = {
369
+ "channelId": getStatsRequest.channelId
370
+ };
353
371
  let headerParams = {
354
372
  "Content-Type": common.Constants.APPLICATION_JSON,
355
373
  "opc-request-id": getStatsRequest.opcRequestId
@@ -391,12 +409,86 @@ class QueueClient {
391
409
  });
392
410
  }
393
411
  /**
394
- * Puts messages in the queue
412
+ * Gets the list of IDs of non-empty channels.
413
+ * It will return an approximate list of IDs of non-empty channels. That information is based on the queue level statistics.
414
+ * API supports optional channelFilter parameter which will filter the returned results according to the specified filter.
415
+ * List of channel IDs is approximate, because statistics is refreshed once per-second, and that list represents a snapshot of the past information. API is paginated.
416
+ *
417
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
418
+ * @param ListChannelsRequest
419
+ * @return ListChannelsResponse
420
+ * @throws OciError when an error occurs
421
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/ListChannels.ts.html |here} to see how to use ListChannels API.
422
+ */
423
+ listChannels(listChannelsRequest) {
424
+ return __awaiter(this, void 0, void 0, function* () {
425
+ if (this.logger)
426
+ this.logger.debug("Calling operation QueueClient#listChannels.");
427
+ const operationName = "listChannels";
428
+ const apiReferenceLink = "";
429
+ const pathParams = {
430
+ "{queueId}": listChannelsRequest.queueId
431
+ };
432
+ const queryParams = {
433
+ "limit": listChannelsRequest.limit,
434
+ "page": listChannelsRequest.page,
435
+ "channelFilter": listChannelsRequest.channelFilter
436
+ };
437
+ let headerParams = {
438
+ "Content-Type": common.Constants.APPLICATION_JSON,
439
+ "opc-request-id": listChannelsRequest.opcRequestId
440
+ };
441
+ const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
442
+ const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, listChannelsRequest.retryConfiguration, specRetryConfiguration);
443
+ if (this.logger)
444
+ retrier.logger = this.logger;
445
+ const request = yield oci_common_1.composeRequest({
446
+ baseEndpoint: this._endpoint,
447
+ defaultHeaders: this._defaultHeaders,
448
+ path: "/queues/{queueId}/channels",
449
+ method: "GET",
450
+ pathParams: pathParams,
451
+ headerParams: headerParams,
452
+ queryParams: queryParams
453
+ });
454
+ try {
455
+ const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
456
+ const sdkResponse = oci_common_1.composeResponse({
457
+ responseObject: {},
458
+ body: yield response.json(),
459
+ bodyKey: "channelCollection",
460
+ bodyModel: model.ChannelCollection,
461
+ type: "model.ChannelCollection",
462
+ responseHeaders: [
463
+ {
464
+ value: response.headers.get("opc-request-id"),
465
+ key: "opcRequestId",
466
+ dataType: "string"
467
+ },
468
+ {
469
+ value: response.headers.get("opc-next-page"),
470
+ key: "opcNextPage",
471
+ dataType: "string"
472
+ }
473
+ ]
474
+ });
475
+ return sdkResponse;
476
+ }
477
+ catch (err) {
478
+ throw err;
479
+ }
480
+ });
481
+ }
482
+ /**
483
+ * Puts messages into the queue.
484
+ * You must use the [messages endpoint](https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to produce messages.
485
+ * The messages endpoint may be different for different queues. Use {@link #getQueue(GetQueueRequest) getQueue} to find the queue's `messagesEndpoint`.
486
+ *
395
487
  * This operation does not retry by default if the user has not defined a retry configuration.
396
488
  * @param PutMessagesRequest
397
489
  * @return PutMessagesResponse
398
490
  * @throws OciError when an error occurs
399
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/PutMessages.ts.html |here} to see how to use PutMessages API.
491
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/PutMessages.ts.html |here} to see how to use PutMessages API.
400
492
  */
401
493
  putMessages(putMessagesRequest) {
402
494
  return __awaiter(this, void 0, void 0, function* () {
@@ -451,11 +543,14 @@ class QueueClient {
451
543
  }
452
544
  /**
453
545
  * Updates the visibility of the message represented by the receipt.
546
+ * You must use the [messages endpoint](https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to update messages.
547
+ * The messages endpoint may be different for different queues. Use {@link #getQueue(GetQueueRequest) getQueue} to find the queue's `messagesEndpoint`.
548
+ *
454
549
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
455
550
  * @param UpdateMessageRequest
456
551
  * @return UpdateMessageResponse
457
552
  * @throws OciError when an error occurs
458
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/UpdateMessage.ts.html |here} to see how to use UpdateMessage API.
553
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/UpdateMessage.ts.html |here} to see how to use UpdateMessage API.
459
554
  */
460
555
  updateMessage(updateMessageRequest) {
461
556
  return __awaiter(this, void 0, void 0, function* () {
@@ -511,11 +606,14 @@ class QueueClient {
511
606
  }
512
607
  /**
513
608
  * Updates multiple messages in the queue.
609
+ * You must use the [messages endpoint](https://docs.cloud.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to update messages.
610
+ * The messages endpoint may be different for different queues. Use {@link #getQueue(GetQueueRequest) getQueue} to find the queue's `messagesEndpoint`.
611
+ *
514
612
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
515
613
  * @param UpdateMessagesRequest
516
614
  * @return UpdateMessagesResponse
517
615
  * @throws OciError when an error occurs
518
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/UpdateMessages.ts.html |here} to see how to use UpdateMessages API.
616
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/UpdateMessages.ts.html |here} to see how to use UpdateMessages API.
519
617
  */
520
618
  updateMessages(updateMessagesRequest) {
521
619
  return __awaiter(this, void 0, void 0, function* () {
@@ -702,12 +800,12 @@ class QueueAdminClient {
702
800
  throw Error("Waiters do not exist. Please create waiters.");
703
801
  }
704
802
  /**
705
- * Moves a Queue resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
803
+ * Moves a queue from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
706
804
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
707
805
  * @param ChangeQueueCompartmentRequest
708
806
  * @return ChangeQueueCompartmentResponse
709
807
  * @throws OciError when an error occurs
710
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/ChangeQueueCompartment.ts.html |here} to see how to use ChangeQueueCompartment API.
808
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/ChangeQueueCompartment.ts.html |here} to see how to use ChangeQueueCompartment API.
711
809
  */
712
810
  changeQueueCompartment(changeQueueCompartmentRequest) {
713
811
  return __awaiter(this, void 0, void 0, function* () {
@@ -763,13 +861,13 @@ class QueueAdminClient {
763
861
  });
764
862
  }
765
863
  /**
766
- * Creates a new Queue.
864
+ * Creates a new queue.
767
865
  *
768
866
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
769
867
  * @param CreateQueueRequest
770
868
  * @return CreateQueueResponse
771
869
  * @throws OciError when an error occurs
772
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/CreateQueue.ts.html |here} to see how to use CreateQueue API.
870
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/CreateQueue.ts.html |here} to see how to use CreateQueue API.
773
871
  */
774
872
  createQueue(createQueueRequest) {
775
873
  return __awaiter(this, void 0, void 0, function* () {
@@ -823,12 +921,12 @@ class QueueAdminClient {
823
921
  });
824
922
  }
825
923
  /**
826
- * Deletes a Queue resource by identifier
924
+ * Deletes a queue resource by identifier.
827
925
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
828
926
  * @param DeleteQueueRequest
829
927
  * @return DeleteQueueResponse
830
928
  * @throws OciError when an error occurs
831
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/DeleteQueue.ts.html |here} to see how to use DeleteQueue API.
929
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/DeleteQueue.ts.html |here} to see how to use DeleteQueue API.
832
930
  */
833
931
  deleteQueue(deleteQueueRequest) {
834
932
  return __awaiter(this, void 0, void 0, function* () {
@@ -883,12 +981,12 @@ class QueueAdminClient {
883
981
  });
884
982
  }
885
983
  /**
886
- * Gets a Queue by identifier
984
+ * Gets a queue by identifier.
887
985
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
888
986
  * @param GetQueueRequest
889
987
  * @return GetQueueResponse
890
988
  * @throws OciError when an error occurs
891
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/GetQueue.ts.html |here} to see how to use GetQueue API.
989
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/GetQueue.ts.html |here} to see how to use GetQueue API.
892
990
  */
893
991
  getQueue(getQueueRequest) {
894
992
  return __awaiter(this, void 0, void 0, function* () {
@@ -951,7 +1049,7 @@ class QueueAdminClient {
951
1049
  * @param GetWorkRequestRequest
952
1050
  * @return GetWorkRequestResponse
953
1051
  * @throws OciError when an error occurs
954
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
1052
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
955
1053
  */
956
1054
  getWorkRequest(getWorkRequestRequest) {
957
1055
  return __awaiter(this, void 0, void 0, function* () {
@@ -1009,13 +1107,13 @@ class QueueAdminClient {
1009
1107
  });
1010
1108
  }
1011
1109
  /**
1012
- * Returns a list of Queues.
1110
+ * Returns a list of queues.
1013
1111
  *
1014
1112
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
1015
1113
  * @param ListQueuesRequest
1016
1114
  * @return ListQueuesResponse
1017
1115
  * @throws OciError when an error occurs
1018
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/ListQueues.ts.html |here} to see how to use ListQueues API.
1116
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/ListQueues.ts.html |here} to see how to use ListQueues API.
1019
1117
  */
1020
1118
  listQueues(listQueuesRequest) {
1021
1119
  return __awaiter(this, void 0, void 0, function* () {
@@ -1086,7 +1184,7 @@ class QueueAdminClient {
1086
1184
  * @param ListWorkRequestErrorsRequest
1087
1185
  * @return ListWorkRequestErrorsResponse
1088
1186
  * @throws OciError when an error occurs
1089
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
1187
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
1090
1188
  */
1091
1189
  listWorkRequestErrors(listWorkRequestErrorsRequest) {
1092
1190
  return __awaiter(this, void 0, void 0, function* () {
@@ -1153,7 +1251,7 @@ class QueueAdminClient {
1153
1251
  * @param ListWorkRequestLogsRequest
1154
1252
  * @return ListWorkRequestLogsResponse
1155
1253
  * @throws OciError when an error occurs
1156
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
1254
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
1157
1255
  */
1158
1256
  listWorkRequestLogs(listWorkRequestLogsRequest) {
1159
1257
  return __awaiter(this, void 0, void 0, function* () {
@@ -1220,7 +1318,7 @@ class QueueAdminClient {
1220
1318
  * @param ListWorkRequestsRequest
1221
1319
  * @return ListWorkRequestsResponse
1222
1320
  * @throws OciError when an error occurs
1223
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
1321
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
1224
1322
  */
1225
1323
  listWorkRequests(listWorkRequestsRequest) {
1226
1324
  return __awaiter(this, void 0, void 0, function* () {
@@ -1281,14 +1379,15 @@ class QueueAdminClient {
1281
1379
  });
1282
1380
  }
1283
1381
  /**
1284
- * Deletes all messages present in the queue at the time of invocation. Only one concurrent purge operation is supported for any given queue.
1382
+ * 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.
1285
1383
  * However multiple concurrent purge operations are supported for different queues.
1384
+ * Purge request without specification of target channels will clean up all messages in the queue and in the child channels.
1286
1385
  *
1287
1386
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
1288
1387
  * @param PurgeQueueRequest
1289
1388
  * @return PurgeQueueResponse
1290
1389
  * @throws OciError when an error occurs
1291
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/PurgeQueue.ts.html |here} to see how to use PurgeQueue API.
1390
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/PurgeQueue.ts.html |here} to see how to use PurgeQueue API.
1292
1391
  */
1293
1392
  purgeQueue(purgeQueueRequest) {
1294
1393
  return __awaiter(this, void 0, void 0, function* () {
@@ -1344,12 +1443,12 @@ class QueueAdminClient {
1344
1443
  });
1345
1444
  }
1346
1445
  /**
1347
- * Updates the Queue
1446
+ * Updates the specified queue.
1348
1447
  * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
1349
1448
  * @param UpdateQueueRequest
1350
1449
  * @return UpdateQueueResponse
1351
1450
  * @throws OciError when an error occurs
1352
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.69.0/queue/UpdateQueue.ts.html |here} to see how to use UpdateQueue API.
1451
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/queue/UpdateQueue.ts.html |here} to see how to use UpdateQueue API.
1353
1452
  */
1354
1453
  updateQueue(updateQueueRequest) {
1355
1454
  return __awaiter(this, void 0, void 0, function* () {