oci-queue 2.69.0 → 2.70.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 (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
@@ -12,11 +12,11 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @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 DeleteQueueRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.0/queue/DeleteQueue.ts.html |here} to see how to use DeleteQueueRequest.
16
16
  */
17
17
  export interface DeleteQueueRequest extends common.BaseRequest {
18
18
  /**
19
- * unique Queue identifier
19
+ * The unique queue identifier.
20
20
  */
21
21
  "queueId": string;
22
22
  /**
@@ -29,7 +29,7 @@ export interface DeleteQueueRequest extends common.BaseRequest {
29
29
  */
30
30
  "ifMatch"?: string;
31
31
  /**
32
- * The client request ID for tracing.
32
+ * Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
33
33
  */
34
34
  "opcRequestId"?: string;
35
35
  }
@@ -12,37 +12,41 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @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 GetMessagesRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.0/queue/GetMessages.ts.html |here} to see how to use GetMessagesRequest.
16
16
  */
17
17
  export interface GetMessagesRequest extends common.BaseRequest {
18
18
  /**
19
- * unique Queue identifier
19
+ * The unique queue identifier.
20
20
  */
21
21
  "queueId": string;
22
22
  /**
23
- * If the visibilityInSeconds parameter is set, messages will be hidden for visibilityInSeconds seconds and won't be consumable by other consumers during that time.
24
- * If it isn't set it defaults to the value set at the queue level. The minimum is 0 and the maximum is 43,200 (12 hours).
25
- * Using a visibilityInSeconds of 0, effectively acts as a peek functionality.
26
- * Messages retrieved that way, aren't meant to be deleted because they will most likely be delivered to another consumer as their visibility won't change, but will still increase the delivery count by one.
27
- *
28
- */
23
+ * If the `visibilityInSeconds` parameter is set, messages will be hidden for `visibilityInSeconds` seconds and won't be consumable by other consumers during that time.
24
+ * If it isn't set it defaults to the value set at the queue level.
25
+ * <p>
26
+ Using a `visibilityInSeconds` value of 0 effectively acts as a peek functionality.
27
+ * Messages retrieved that way aren't meant to be deleted because they will most likely be delivered to another consumer as their visibility won't change, but will still increase the delivery count by one.
28
+ *
29
+ */
29
30
  "visibilityInSeconds"?: number;
30
31
  /**
31
- * If the timeoutInSeconds parameter isn't set or set to a value greater than zero, the request is using the long-polling mode and will only return when a message is available for consumption (it does not wait for limit messages but still only returns at-most limit messages) or after timeoutInSeconds seconds (in which case it will return an empty response) whichever comes first.
32
- * If the parameter is set to zero, the request is using the short-polling mode and immediately returns whether messages have been retrieved or not.
33
- * In same rare-cases a long-polling request could be interrupted (returned with empty response) before the end of the timeout.
34
- * The minimum is 0 (long polling disabled), the maximum is 30 seconds and default is 30 seconds.
35
- *
36
- */
32
+ * If the `timeoutInSeconds parameter` isn't set or it is set to a value greater than 0, the request is using the long-polling mode and will only return when a message is available for consumption (it does not wait for limit messages but still only returns at-most limit messages) or after `timeoutInSeconds` seconds (in which case it will return an empty response), whichever comes first.
33
+ * <p>
34
+ If the parameter is set to 0, the request is using the short-polling mode and immediately returns whether messages have been retrieved or not.
35
+ * In same rare-cases a long-polling request could be interrupted (returned with empty response) before the end of the timeout.
36
+ *
37
+ */
37
38
  "timeoutInSeconds"?: number;
38
39
  /**
39
40
  * The limit parameter controls how many messages is returned at-most.
40
- * The default is 1, the minimum is 1 and the maximum is 32.
41
41
  *
42
42
  */
43
43
  "limit"?: number;
44
44
  /**
45
- * The client request ID for tracing.
45
+ * Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
46
46
  */
47
47
  "opcRequestId"?: string;
48
+ /**
49
+ * Optional parameter to filter the channels.
50
+ */
51
+ "channelFilter"?: string;
48
52
  }
@@ -12,15 +12,15 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @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 GetQueueRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.0/queue/GetQueue.ts.html |here} to see how to use GetQueueRequest.
16
16
  */
17
17
  export interface GetQueueRequest extends common.BaseRequest {
18
18
  /**
19
- * unique Queue identifier
19
+ * The unique queue identifier.
20
20
  */
21
21
  "queueId": string;
22
22
  /**
23
- * The client request ID for tracing.
23
+ * Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
24
24
  */
25
25
  "opcRequestId"?: string;
26
26
  }
@@ -12,15 +12,19 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @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 GetStatsRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.0/queue/GetStats.ts.html |here} to see how to use GetStatsRequest.
16
16
  */
17
17
  export interface GetStatsRequest extends common.BaseRequest {
18
18
  /**
19
- * unique Queue identifier
19
+ * The unique queue identifier.
20
20
  */
21
21
  "queueId": string;
22
22
  /**
23
- * The client request ID for tracing.
23
+ * Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
24
24
  */
25
25
  "opcRequestId"?: string;
26
+ /**
27
+ * Id to specify channel.
28
+ */
29
+ "channelId"?: string;
26
30
  }
@@ -12,7 +12,7 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @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 GetWorkRequestRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.0/queue/GetWorkRequest.ts.html |here} to see how to use GetWorkRequestRequest.
16
16
  */
17
17
  export interface GetWorkRequestRequest extends common.BaseRequest {
18
18
  /**
@@ -20,7 +20,7 @@ export interface GetWorkRequestRequest extends common.BaseRequest {
20
20
  */
21
21
  "workRequestId": string;
22
22
  /**
23
- * The client request ID for tracing.
23
+ * Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
24
24
  */
25
25
  "opcRequestId"?: string;
26
26
  }
@@ -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
  *
@@ -18,6 +18,8 @@ import * as GetMessagesRequest from "./get-messages-request";
18
18
  export import GetMessagesRequest = GetMessagesRequest.GetMessagesRequest;
19
19
  import * as GetStatsRequest from "./get-stats-request";
20
20
  export import GetStatsRequest = GetStatsRequest.GetStatsRequest;
21
+ import * as ListChannelsRequest from "./list-channels-request";
22
+ export import ListChannelsRequest = ListChannelsRequest.ListChannelsRequest;
21
23
  import * as PutMessagesRequest from "./put-messages-request";
22
24
  export import PutMessagesRequest = PutMessagesRequest.PutMessagesRequest;
23
25
  import * as UpdateMessageRequest from "./update-message-request";
@@ -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
  *
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../lib/queue/lib/request/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;;;;;;;;;;;;;;;;;AA0BH,yEAA2D;AAC7C,QAAA,iBAAiB,GAAG,iBAAiB,CAAC,iBAAiB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../lib/queue/lib/request/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;;;;;;;;;;;;;;;;;AA4BH,yEAA2D;AAC7C,QAAA,iBAAiB,GAAG,iBAAiB,CAAC,iBAAiB,CAAC"}
@@ -0,0 +1,38 @@
1
+ /**
2
+ *
3
+ *
4
+ * OpenAPI spec version: 20210201
5
+ *
6
+ *
7
+ * NOTE: This class is auto generated by OracleSDKGenerator.
8
+ * Do not edit the class manually.
9
+ *
10
+ * Copyright (c) 2020, 2023, Oracle and/or its affiliates. All rights reserved.
11
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
12
+ */
13
+ import common = require("oci-common");
14
+ /**
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.0/queue/ListChannels.ts.html |here} to see how to use ListChannelsRequest.
16
+ */
17
+ export interface ListChannelsRequest extends common.BaseRequest {
18
+ /**
19
+ * The unique queue identifier.
20
+ */
21
+ "queueId": string;
22
+ /**
23
+ * Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
24
+ */
25
+ "opcRequestId"?: string;
26
+ /**
27
+ * For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
28
+ */
29
+ "limit"?: number;
30
+ /**
31
+ * For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
32
+ */
33
+ "page"?: string;
34
+ /**
35
+ * Optional parameter to filter the channels.
36
+ */
37
+ "channelFilter"?: string;
38
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /**
3
+ *
4
+ *
5
+ * OpenAPI spec version: 20210201
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OracleSDKGenerator.
9
+ * Do not edit the class manually.
10
+ *
11
+ * Copyright (c) 2020, 2023, Oracle and/or its affiliates. All rights reserved.
12
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
13
+ */
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ //# sourceMappingURL=list-channels-request.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"list-channels-request.js","sourceRoot":"","sources":["../../../../../lib/queue/lib/request/list-channels-request.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG"}
@@ -13,11 +13,11 @@
13
13
  import * as model from "../model";
14
14
  import common = require("oci-common");
15
15
  /**
16
- * @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 ListQueuesRequest.
16
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.0/queue/ListQueues.ts.html |here} to see how to use ListQueuesRequest.
17
17
  */
18
18
  export interface ListQueuesRequest extends common.BaseRequest {
19
19
  /**
20
- * The ID of the compartment in which to list resources.
20
+ * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
21
21
  */
22
22
  "compartmentId"?: string;
23
23
  /**
@@ -29,15 +29,15 @@ export interface ListQueuesRequest extends common.BaseRequest {
29
29
  */
30
30
  "displayName"?: string;
31
31
  /**
32
- * unique Queue identifier
32
+ * The unique queue identifier.
33
33
  */
34
34
  "id"?: string;
35
35
  /**
36
- * The maximum number of items to return.
36
+ * For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
37
37
  */
38
38
  "limit"?: number;
39
39
  /**
40
- * The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
40
+ * For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
41
41
  */
42
42
  "page"?: string;
43
43
  /**
@@ -50,7 +50,7 @@ export interface ListQueuesRequest extends common.BaseRequest {
50
50
  */
51
51
  "sortBy"?: ListQueuesRequest.SortBy;
52
52
  /**
53
- * The client request ID for tracing.
53
+ * Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
54
54
  */
55
55
  "opcRequestId"?: string;
56
56
  }
@@ -12,7 +12,7 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @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 ListWorkRequestErrorsRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.0/queue/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrorsRequest.
16
16
  */
17
17
  export interface ListWorkRequestErrorsRequest extends common.BaseRequest {
18
18
  /**
@@ -20,15 +20,15 @@ export interface ListWorkRequestErrorsRequest extends common.BaseRequest {
20
20
  */
21
21
  "workRequestId": string;
22
22
  /**
23
- * The client request ID for tracing.
23
+ * Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
24
24
  */
25
25
  "opcRequestId"?: string;
26
26
  /**
27
- * The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
27
+ * For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
28
28
  */
29
29
  "page"?: string;
30
30
  /**
31
- * The maximum number of items to return.
31
+ * For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
32
32
  */
33
33
  "limit"?: number;
34
34
  }
@@ -12,7 +12,7 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @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 ListWorkRequestLogsRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.0/queue/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogsRequest.
16
16
  */
17
17
  export interface ListWorkRequestLogsRequest extends common.BaseRequest {
18
18
  /**
@@ -20,15 +20,15 @@ export interface ListWorkRequestLogsRequest extends common.BaseRequest {
20
20
  */
21
21
  "workRequestId": string;
22
22
  /**
23
- * The client request ID for tracing.
23
+ * Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
24
24
  */
25
25
  "opcRequestId"?: string;
26
26
  /**
27
- * The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
27
+ * For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
28
28
  */
29
29
  "page"?: string;
30
30
  /**
31
- * The maximum number of items to return.
31
+ * For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
32
32
  */
33
33
  "limit"?: number;
34
34
  }
@@ -12,11 +12,11 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @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 ListWorkRequestsRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.0/queue/ListWorkRequests.ts.html |here} to see how to use ListWorkRequestsRequest.
16
16
  */
17
17
  export interface ListWorkRequestsRequest extends common.BaseRequest {
18
18
  /**
19
- * The ID of the compartment in which to list resources.
19
+ * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
20
20
  */
21
21
  "compartmentId"?: string;
22
22
  /**
@@ -24,15 +24,15 @@ export interface ListWorkRequestsRequest extends common.BaseRequest {
24
24
  */
25
25
  "workRequestId"?: string;
26
26
  /**
27
- * The client request ID for tracing.
27
+ * Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
28
28
  */
29
29
  "opcRequestId"?: string;
30
30
  /**
31
- * The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
31
+ * For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
32
32
  */
33
33
  "page"?: string;
34
34
  /**
35
- * The maximum number of items to return.
35
+ * For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
36
36
  */
37
37
  "limit"?: number;
38
38
  }
@@ -13,11 +13,11 @@
13
13
  import * as model from "../model";
14
14
  import common = require("oci-common");
15
15
  /**
16
- * @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 PurgeQueueRequest.
16
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.0/queue/PurgeQueue.ts.html |here} to see how to use PurgeQueueRequest.
17
17
  */
18
18
  export interface PurgeQueueRequest extends common.BaseRequest {
19
19
  /**
20
- * unique Queue identifier
20
+ * The unique queue identifier.
21
21
  */
22
22
  "queueId": string;
23
23
  /**
@@ -34,7 +34,7 @@ export interface PurgeQueueRequest extends common.BaseRequest {
34
34
  */
35
35
  "ifMatch"?: string;
36
36
  /**
37
- * The client request ID for tracing.
37
+ * Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
38
38
  */
39
39
  "opcRequestId"?: string;
40
40
  }
@@ -13,11 +13,11 @@
13
13
  import * as model from "../model";
14
14
  import common = require("oci-common");
15
15
  /**
16
- * @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 PutMessagesRequest.
16
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.0/queue/PutMessages.ts.html |here} to see how to use PutMessagesRequest.
17
17
  */
18
18
  export interface PutMessagesRequest extends common.BaseRequest {
19
19
  /**
20
- * unique Queue identifier
20
+ * The unique queue identifier.
21
21
  */
22
22
  "queueId": string;
23
23
  /**
@@ -25,7 +25,7 @@ export interface PutMessagesRequest extends common.BaseRequest {
25
25
  */
26
26
  "putMessagesDetails": model.PutMessagesDetails;
27
27
  /**
28
- * The client request ID for tracing.
28
+ * Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
29
29
  */
30
30
  "opcRequestId"?: string;
31
31
  }
@@ -13,11 +13,11 @@
13
13
  import * as model from "../model";
14
14
  import common = require("oci-common");
15
15
  /**
16
- * @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 UpdateMessageRequest.
16
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.0/queue/UpdateMessage.ts.html |here} to see how to use UpdateMessageRequest.
17
17
  */
18
18
  export interface UpdateMessageRequest extends common.BaseRequest {
19
19
  /**
20
- * unique Queue identifier
20
+ * The unique queue identifier.
21
21
  */
22
22
  "queueId": string;
23
23
  /**
@@ -29,7 +29,7 @@ export interface UpdateMessageRequest extends common.BaseRequest {
29
29
  */
30
30
  "updateMessageDetails": model.UpdateMessageDetails;
31
31
  /**
32
- * The client request ID for tracing.
32
+ * Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
33
33
  */
34
34
  "opcRequestId"?: string;
35
35
  }
@@ -13,11 +13,11 @@
13
13
  import * as model from "../model";
14
14
  import common = require("oci-common");
15
15
  /**
16
- * @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 UpdateMessagesRequest.
16
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.0/queue/UpdateMessages.ts.html |here} to see how to use UpdateMessagesRequest.
17
17
  */
18
18
  export interface UpdateMessagesRequest extends common.BaseRequest {
19
19
  /**
20
- * unique Queue identifier
20
+ * The unique queue identifier.
21
21
  */
22
22
  "queueId": string;
23
23
  /**
@@ -25,7 +25,7 @@ export interface UpdateMessagesRequest extends common.BaseRequest {
25
25
  */
26
26
  "updateMessagesDetails": model.UpdateMessagesDetails;
27
27
  /**
28
- * The client request ID for tracing.
28
+ * Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
29
29
  */
30
30
  "opcRequestId"?: string;
31
31
  }
@@ -13,11 +13,11 @@
13
13
  import * as model from "../model";
14
14
  import common = require("oci-common");
15
15
  /**
16
- * @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 UpdateQueueRequest.
16
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.0/queue/UpdateQueue.ts.html |here} to see how to use UpdateQueueRequest.
17
17
  */
18
18
  export interface UpdateQueueRequest extends common.BaseRequest {
19
19
  /**
20
- * unique Queue identifier
20
+ * The unique queue identifier.
21
21
  */
22
22
  "queueId": string;
23
23
  /**
@@ -34,7 +34,7 @@ export interface UpdateQueueRequest extends common.BaseRequest {
34
34
  */
35
35
  "ifMatch"?: string;
36
36
  /**
37
- * The client request ID for tracing.
37
+ * Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
38
38
  */
39
39
  "opcRequestId"?: string;
40
40
  }
@@ -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
  *
@@ -18,6 +18,8 @@ import * as GetMessagesResponse from "./get-messages-response";
18
18
  export import GetMessagesResponse = GetMessagesResponse.GetMessagesResponse;
19
19
  import * as GetStatsResponse from "./get-stats-response";
20
20
  export import GetStatsResponse = GetStatsResponse.GetStatsResponse;
21
+ import * as ListChannelsResponse from "./list-channels-response";
22
+ export import ListChannelsResponse = ListChannelsResponse.ListChannelsResponse;
21
23
  import * as PutMessagesResponse from "./put-messages-response";
22
24
  export import PutMessagesResponse = PutMessagesResponse.PutMessagesResponse;
23
25
  import * as UpdateMessageResponse from "./update-message-response";
@@ -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
  *
@@ -0,0 +1,32 @@
1
+ /**
2
+ *
3
+ *
4
+ * OpenAPI spec version: 20210201
5
+ *
6
+ *
7
+ * NOTE: This class is auto generated by OracleSDKGenerator.
8
+ * Do not edit the class manually.
9
+ *
10
+ * Copyright (c) 2020, 2023, Oracle and/or its affiliates. All rights reserved.
11
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
12
+ */
13
+ import * as model from "../model";
14
+ export interface ListChannelsResponse {
15
+ /**
16
+ * Unique Oracle-assigned identifier for the request. If you need to contact
17
+ * Oracle about a particular request, please provide the request ID.
18
+ *
19
+ */
20
+ "opcRequestId": string;
21
+ /**
22
+ * For pagination of a list of items. When paging through a list, if this header appears in the response,
23
+ * then a partial list might have been returned. Include this value as the `page` parameter for the
24
+ * subsequent GET request to get the next batch of items.
25
+ *
26
+ */
27
+ "opcNextPage": string;
28
+ /**
29
+ * The returned model.ChannelCollection instance.
30
+ */
31
+ "channelCollection": model.ChannelCollection;
32
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /**
3
+ *
4
+ *
5
+ * OpenAPI spec version: 20210201
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OracleSDKGenerator.
9
+ * Do not edit the class manually.
10
+ *
11
+ * Copyright (c) 2020, 2023, Oracle and/or its affiliates. All rights reserved.
12
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
13
+ */
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ //# sourceMappingURL=list-channels-response.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"list-channels-response.js","sourceRoot":"","sources":["../../../../../lib/queue/lib/response/list-channels-response.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "oci-queue",
3
- "version": "2.69.0",
3
+ "version": "2.70.0",
4
4
  "description": "OCI NodeJS client for Queue Service",
5
5
  "repository": {
6
6
  "type": "git",
@@ -15,8 +15,8 @@
15
15
  },
16
16
  "license": "(UPL-1.0 OR Apache-2.0)",
17
17
  "dependencies": {
18
- "oci-common": "2.69.0",
19
- "oci-workrequests": "2.69.0"
18
+ "oci-common": "2.70.0",
19
+ "oci-workrequests": "2.70.0"
20
20
  },
21
21
  "publishConfig": {
22
22
  "registry": "https://registry.npmjs.org"