oci-streaming 2.4.0 → 2.6.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 (31) hide show
  1. package/LICENSE.txt +6 -0
  2. package/lib/client.d.ts +109 -26
  3. package/lib/client.js +187 -52
  4. package/lib/client.js.map +1 -1
  5. package/lib/request/change-connect-harness-compartment-request.d.ts +1 -1
  6. package/lib/request/change-stream-compartment-request.d.ts +1 -1
  7. package/lib/request/change-stream-pool-compartment-request.d.ts +1 -1
  8. package/lib/request/consumer-commit-request.d.ts +1 -1
  9. package/lib/request/consumer-heartbeat-request.d.ts +1 -1
  10. package/lib/request/create-connect-harness-request.d.ts +1 -1
  11. package/lib/request/create-cursor-request.d.ts +1 -1
  12. package/lib/request/create-group-cursor-request.d.ts +1 -1
  13. package/lib/request/create-stream-pool-request.d.ts +1 -1
  14. package/lib/request/create-stream-request.d.ts +1 -1
  15. package/lib/request/delete-connect-harness-request.d.ts +1 -1
  16. package/lib/request/delete-stream-pool-request.d.ts +1 -1
  17. package/lib/request/delete-stream-request.d.ts +1 -1
  18. package/lib/request/get-connect-harness-request.d.ts +1 -1
  19. package/lib/request/get-group-request.d.ts +1 -1
  20. package/lib/request/get-messages-request.d.ts +1 -1
  21. package/lib/request/get-stream-pool-request.d.ts +1 -1
  22. package/lib/request/get-stream-request.d.ts +1 -1
  23. package/lib/request/list-connect-harnesses-request.d.ts +1 -1
  24. package/lib/request/list-stream-pools-request.d.ts +1 -1
  25. package/lib/request/list-streams-request.d.ts +1 -1
  26. package/lib/request/put-messages-request.d.ts +1 -1
  27. package/lib/request/update-connect-harness-request.d.ts +1 -1
  28. package/lib/request/update-group-request.d.ts +1 -1
  29. package/lib/request/update-stream-pool-request.d.ts +1 -1
  30. package/lib/request/update-stream-request.d.ts +1 -1
  31. package/package.json +3 -3
package/LICENSE.txt CHANGED
@@ -1,3 +1,9 @@
1
+ Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
2
+
3
+ This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 or Apache License 2.0. See below for license terms. You may choose either license.
4
+
5
+ ____________________________
6
+
1
7
  The Universal Permissive License (UPL), Version 1.0
2
8
 
3
9
  Subject to the condition set forth below, permission is hereby granted to any
package/lib/client.d.ts CHANGED
@@ -17,6 +17,9 @@ import * as responses from "./response";
17
17
  import { StreamAdminWaiter } from "./streamadmin-waiter";
18
18
  export declare enum StreamApiKeys {
19
19
  }
20
+ /**
21
+ * This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.
22
+ */
20
23
  export declare class StreamClient {
21
24
  protected static serviceEndpointTemplate: string;
22
25
  protected "_endpoint": string;
@@ -39,19 +42,21 @@ export declare class StreamClient {
39
42
  * Provides a mechanism to manually commit offsets, if not using commit-on-get consumer semantics.
40
43
  * This commits offsets assicated with the provided cursor, extends the timeout on each of the affected partitions, and returns an updated cursor.
41
44
  *
45
+ * This operation does not retry by default if the user has not defined a retry configuration.
42
46
  * @param ConsumerCommitRequest
43
47
  * @return ConsumerCommitResponse
44
48
  * @throws OciError when an error occurs
45
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/ConsumerCommit.ts.html |here} to see how to use ConsumerCommit API.
49
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/ConsumerCommit.ts.html |here} to see how to use ConsumerCommit API.
46
50
  */
47
51
  consumerCommit(consumerCommitRequest: requests.ConsumerCommitRequest): Promise<responses.ConsumerCommitResponse>;
48
52
  /**
49
53
  * Allows long-running processes to extend the timeout on partitions reserved by a consumer instance.
50
54
  *
55
+ * This operation does not retry by default if the user has not defined a retry configuration.
51
56
  * @param ConsumerHeartbeatRequest
52
57
  * @return ConsumerHeartbeatResponse
53
58
  * @throws OciError when an error occurs
54
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/ConsumerHeartbeat.ts.html |here} to see how to use ConsumerHeartbeat API.
59
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/ConsumerHeartbeat.ts.html |here} to see how to use ConsumerHeartbeat API.
55
60
  */
56
61
  consumerHeartbeat(consumerHeartbeatRequest: requests.ConsumerHeartbeatRequest): Promise<responses.ConsumerHeartbeatResponse>;
57
62
  /**
@@ -61,28 +66,31 @@ export declare class StreamClient {
61
66
  * on the most recent message allows consumption of only messages that are added to the stream after you create the cursor. Cursors expire
62
67
  * five minutes after you receive them from the service.
63
68
  *
69
+ * This operation does not retry by default if the user has not defined a retry configuration.
64
70
  * @param CreateCursorRequest
65
71
  * @return CreateCursorResponse
66
72
  * @throws OciError when an error occurs
67
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/CreateCursor.ts.html |here} to see how to use CreateCursor API.
73
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/CreateCursor.ts.html |here} to see how to use CreateCursor API.
68
74
  */
69
75
  createCursor(createCursorRequest: requests.CreateCursorRequest): Promise<responses.CreateCursorResponse>;
70
76
  /**
71
77
  * Creates a group-cursor.
72
78
  *
79
+ * This operation does not retry by default if the user has not defined a retry configuration.
73
80
  * @param CreateGroupCursorRequest
74
81
  * @return CreateGroupCursorResponse
75
82
  * @throws OciError when an error occurs
76
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/CreateGroupCursor.ts.html |here} to see how to use CreateGroupCursor API.
83
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/CreateGroupCursor.ts.html |here} to see how to use CreateGroupCursor API.
77
84
  */
78
85
  createGroupCursor(createGroupCursorRequest: requests.CreateGroupCursorRequest): Promise<responses.CreateGroupCursorResponse>;
79
86
  /**
80
87
  * Returns the current state of a consumer group.
81
88
  *
89
+ * This operation does not retry by default if the user has not defined a retry configuration.
82
90
  * @param GetGroupRequest
83
91
  * @return GetGroupResponse
84
92
  * @throws OciError when an error occurs
85
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/GetGroup.ts.html |here} to see how to use GetGroup API.
93
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/GetGroup.ts.html |here} to see how to use GetGroup API.
86
94
  */
87
95
  getGroup(getGroupRequest: requests.GetGroupRequest): Promise<responses.GetGroupResponse>;
88
96
  /**
@@ -90,10 +98,11 @@ export declare class StreamClient {
90
98
  * To get messages, you must first obtain a cursor using the {@link #createCursor(CreateCursorRequest) createCursor} operation.
91
99
  * In the response, retrieve the value of the 'opc-next-cursor' header to pass as a parameter to get the next batch of messages in the stream.
92
100
  *
101
+ * This operation does not retry by default if the user has not defined a retry configuration.
93
102
  * @param GetMessagesRequest
94
103
  * @return GetMessagesResponse
95
104
  * @throws OciError when an error occurs
96
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/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.6.0/streaming/GetMessages.ts.html |here} to see how to use GetMessages API.
97
106
  */
98
107
  getMessages(getMessagesRequest: requests.GetMessagesRequest): Promise<responses.GetMessagesResponse>;
99
108
  /**
@@ -102,24 +111,29 @@ export declare class StreamClient {
102
111
  * If a message does not contain a key or if the key is null, the service generates a message key for you.
103
112
  * The partition ID cannot be passed as a parameter.
104
113
  *
114
+ * This operation does not retry by default if the user has not defined a retry configuration.
105
115
  * @param PutMessagesRequest
106
116
  * @return PutMessagesResponse
107
117
  * @throws OciError when an error occurs
108
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/PutMessages.ts.html |here} to see how to use PutMessages API.
118
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/PutMessages.ts.html |here} to see how to use PutMessages API.
109
119
  */
110
120
  putMessages(putMessagesRequest: requests.PutMessagesRequest): Promise<responses.PutMessagesResponse>;
111
121
  /**
112
122
  * Forcefully changes the current location of a group as a whole; reseting processing location of all consumers to a particular location in the stream.
113
123
  *
124
+ * This operation does not retry by default if the user has not defined a retry configuration.
114
125
  * @param UpdateGroupRequest
115
126
  * @return UpdateGroupResponse
116
127
  * @throws OciError when an error occurs
117
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/UpdateGroup.ts.html |here} to see how to use UpdateGroup API.
128
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/UpdateGroup.ts.html |here} to see how to use UpdateGroup API.
118
129
  */
119
130
  updateGroup(updateGroupRequest: requests.UpdateGroupRequest): Promise<responses.UpdateGroupResponse>;
120
131
  }
121
132
  export declare enum StreamAdminApiKeys {
122
133
  }
134
+ /**
135
+ * This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.
136
+ */
123
137
  export declare class StreamAdminClient {
124
138
  protected static serviceEndpointTemplate: string;
125
139
  protected "_endpoint": string;
@@ -169,10 +183,11 @@ export declare class StreamAdminClient {
169
183
  getWaiters(): StreamAdminWaiter;
170
184
  /**
171
185
  * Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
186
+ * This operation does not retry by default if the user has not defined a retry configuration.
172
187
  * @param ChangeConnectHarnessCompartmentRequest
173
188
  * @return ChangeConnectHarnessCompartmentResponse
174
189
  * @throws OciError when an error occurs
175
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/ChangeConnectHarnessCompartment.ts.html |here} to see how to use ChangeConnectHarnessCompartment API.
190
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/ChangeConnectHarnessCompartment.ts.html |here} to see how to use ChangeConnectHarnessCompartment API.
176
191
  */
177
192
  changeConnectHarnessCompartment(changeConnectHarnessCompartmentRequest: requests.ChangeConnectHarnessCompartmentRequest): Promise<responses.ChangeConnectHarnessCompartmentResponse>;
178
193
  /**
@@ -180,28 +195,31 @@ export declare class StreamAdminClient {
180
195
  * When provided, If-Match is checked against ETag values of the resource.
181
196
  * The stream will also be moved into the default stream pool in the destination compartment.
182
197
  *
198
+ * This operation does not retry by default if the user has not defined a retry configuration.
183
199
  * @param ChangeStreamCompartmentRequest
184
200
  * @return ChangeStreamCompartmentResponse
185
201
  * @throws OciError when an error occurs
186
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/ChangeStreamCompartment.ts.html |here} to see how to use ChangeStreamCompartment API.
202
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/ChangeStreamCompartment.ts.html |here} to see how to use ChangeStreamCompartment API.
187
203
  */
188
204
  changeStreamCompartment(changeStreamCompartmentRequest: requests.ChangeStreamCompartmentRequest): Promise<responses.ChangeStreamCompartmentResponse>;
189
205
  /**
190
206
  * Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
207
+ * This operation does not retry by default if the user has not defined a retry configuration.
191
208
  * @param ChangeStreamPoolCompartmentRequest
192
209
  * @return ChangeStreamPoolCompartmentResponse
193
210
  * @throws OciError when an error occurs
194
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/ChangeStreamPoolCompartment.ts.html |here} to see how to use ChangeStreamPoolCompartment API.
211
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/ChangeStreamPoolCompartment.ts.html |here} to see how to use ChangeStreamPoolCompartment API.
195
212
  */
196
213
  changeStreamPoolCompartment(changeStreamPoolCompartmentRequest: requests.ChangeStreamPoolCompartmentRequest): Promise<responses.ChangeStreamPoolCompartmentResponse>;
197
214
  /**
198
215
  * Starts the provisioning of a new connect harness.
199
216
  * To track the progress of the provisioning, you can periodically call {@link ConnectHarness} object tells you its current state.
200
217
  *
218
+ * This operation does not retry by default if the user has not defined a retry configuration.
201
219
  * @param CreateConnectHarnessRequest
202
220
  * @return CreateConnectHarnessResponse
203
221
  * @throws OciError when an error occurs
204
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/CreateConnectHarness.ts.html |here} to see how to use CreateConnectHarness API.
222
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/CreateConnectHarness.ts.html |here} to see how to use CreateConnectHarness API.
205
223
  */
206
224
  createConnectHarness(createConnectHarnessRequest: requests.CreateConnectHarnessRequest): Promise<responses.CreateConnectHarnessResponse>;
207
225
  /**
@@ -211,10 +229,11 @@ export declare class StreamAdminClient {
211
229
  * To track the progress of the provisioning, you can periodically call {@link #getStream(GetStreamRequest) getStream}.
212
230
  * In the response, the `lifecycleState` parameter of the {@link Stream} object tells you its current state.
213
231
  *
232
+ * This operation does not retry by default if the user has not defined a retry configuration.
214
233
  * @param CreateStreamRequest
215
234
  * @return CreateStreamResponse
216
235
  * @throws OciError when an error occurs
217
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/CreateStream.ts.html |here} to see how to use CreateStream API.
236
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/CreateStream.ts.html |here} to see how to use CreateStream API.
218
237
  */
219
238
  createStream(createStreamRequest: requests.CreateStreamRequest): Promise<responses.CreateStreamResponse>;
220
239
  /**
@@ -222,10 +241,11 @@ export declare class StreamAdminClient {
222
241
  * To track the progress of the provisioning, you can periodically call GetStreamPool.
223
242
  * In the response, the `lifecycleState` parameter of the object tells you its current state.
224
243
  *
244
+ * This operation does not retry by default if the user has not defined a retry configuration.
225
245
  * @param CreateStreamPoolRequest
226
246
  * @return CreateStreamPoolResponse
227
247
  * @throws OciError when an error occurs
228
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/CreateStreamPool.ts.html |here} to see how to use CreateStreamPool API.
248
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/CreateStreamPool.ts.html |here} to see how to use CreateStreamPool API.
229
249
  */
230
250
  createStreamPool(createStreamPoolRequest: requests.CreateStreamPoolRequest): Promise<responses.CreateStreamPoolResponse>;
231
251
  /**
@@ -235,10 +255,11 @@ export declare class StreamAdminClient {
235
255
  * lifecycle state as `DELETED`, then the connect harness has been deleted. If the call returns a \"404 Not Found\" error, that means all records of the
236
256
  * connect harness have been deleted.
237
257
  *
258
+ * This operation does not retry by default if the user has not defined a retry configuration.
238
259
  * @param DeleteConnectHarnessRequest
239
260
  * @return DeleteConnectHarnessResponse
240
261
  * @throws OciError when an error occurs
241
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/DeleteConnectHarness.ts.html |here} to see how to use DeleteConnectHarness API.
262
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/DeleteConnectHarness.ts.html |here} to see how to use DeleteConnectHarness API.
242
263
  */
243
264
  deleteConnectHarness(deleteConnectHarnessRequest: requests.DeleteConnectHarnessRequest): Promise<responses.DeleteConnectHarnessResponse>;
244
265
  /**
@@ -248,55 +269,62 @@ export declare class StreamAdminClient {
248
269
  * lifecycle state as `DELETED`, then the stream has been deleted. If the call returns a \"404 Not Found\" error, that means all records of the
249
270
  * stream have been deleted.
250
271
  *
272
+ * This operation does not retry by default if the user has not defined a retry configuration.
251
273
  * @param DeleteStreamRequest
252
274
  * @return DeleteStreamResponse
253
275
  * @throws OciError when an error occurs
254
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/DeleteStream.ts.html |here} to see how to use DeleteStream API.
276
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/DeleteStream.ts.html |here} to see how to use DeleteStream API.
255
277
  */
256
278
  deleteStream(deleteStreamRequest: requests.DeleteStreamRequest): Promise<responses.DeleteStreamResponse>;
257
279
  /**
258
280
  * Deletes a stream pool. All containing streams will also be deleted.
259
281
  * The default stream pool of a compartment cannot be deleted.
260
282
  *
283
+ * This operation does not retry by default if the user has not defined a retry configuration.
261
284
  * @param DeleteStreamPoolRequest
262
285
  * @return DeleteStreamPoolResponse
263
286
  * @throws OciError when an error occurs
264
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/DeleteStreamPool.ts.html |here} to see how to use DeleteStreamPool API.
287
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/DeleteStreamPool.ts.html |here} to see how to use DeleteStreamPool API.
265
288
  */
266
289
  deleteStreamPool(deleteStreamPoolRequest: requests.DeleteStreamPoolRequest): Promise<responses.DeleteStreamPoolResponse>;
267
290
  /**
268
291
  * Gets detailed information about a connect harness.
292
+ * This operation does not retry by default if the user has not defined a retry configuration.
269
293
  * @param GetConnectHarnessRequest
270
294
  * @return GetConnectHarnessResponse
271
295
  * @throws OciError when an error occurs
272
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/GetConnectHarness.ts.html |here} to see how to use GetConnectHarness API.
296
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/GetConnectHarness.ts.html |here} to see how to use GetConnectHarness API.
273
297
  */
274
298
  getConnectHarness(getConnectHarnessRequest: requests.GetConnectHarnessRequest): Promise<responses.GetConnectHarnessResponse>;
275
299
  /**
276
300
  * Gets detailed information about a stream, including the number of partitions.
301
+ * This operation does not retry by default if the user has not defined a retry configuration.
277
302
  * @param GetStreamRequest
278
303
  * @return GetStreamResponse
279
304
  * @throws OciError when an error occurs
280
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/GetStream.ts.html |here} to see how to use GetStream API.
305
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/GetStream.ts.html |here} to see how to use GetStream API.
281
306
  */
282
307
  getStream(getStreamRequest: requests.GetStreamRequest): Promise<responses.GetStreamResponse>;
283
308
  /**
284
309
  * Gets detailed information about the stream pool, such as Kafka settings.
310
+ * This operation does not retry by default if the user has not defined a retry configuration.
285
311
  * @param GetStreamPoolRequest
286
312
  * @return GetStreamPoolResponse
287
313
  * @throws OciError when an error occurs
288
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/GetStreamPool.ts.html |here} to see how to use GetStreamPool API.
314
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/GetStreamPool.ts.html |here} to see how to use GetStreamPool API.
289
315
  */
290
316
  getStreamPool(getStreamPoolRequest: requests.GetStreamPoolRequest): Promise<responses.GetStreamPoolResponse>;
291
317
  /**
292
318
  * Lists the connectharness.
319
+ * This operation does not retry by default if the user has not defined a retry configuration.
293
320
  * @param ListConnectHarnessesRequest
294
321
  * @return ListConnectHarnessesResponse
295
322
  * @throws OciError when an error occurs
296
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/ListConnectHarnesses.ts.html |here} to see how to use ListConnectHarnesses API.
323
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/ListConnectHarnesses.ts.html |here} to see how to use ListConnectHarnesses API.
297
324
  */
298
325
  listConnectHarnesses(listConnectHarnessesRequest: requests.ListConnectHarnessesRequest): Promise<responses.ListConnectHarnessesResponse>;
299
326
  /**
327
+ * NOTE: This function is deprecated in favor of listConnectHarnessesRecordIterator function.
300
328
  * Creates a new async iterator which will iterate over the models.ConnectHarnessSummary objects
301
329
  * contained in responses from the listConnectHarnesses operation. This iterator will fetch more data from the
302
330
  * server as needed.
@@ -305,21 +333,39 @@ export declare class StreamAdminClient {
305
333
  */
306
334
  listAllConnectHarnesses(request: requests.ListConnectHarnessesRequest): AsyncIterableIterator<model.ConnectHarnessSummary>;
307
335
  /**
336
+ * NOTE: This function is deprecated in favor of listConnectHarnessesResponseIterator function.
308
337
  * Creates a new async iterator which will iterate over the responses received from the listConnectHarnesses operation. This iterator
309
338
  * will fetch more data from the server as needed.
310
339
  *
311
340
  * @param request a request which can be sent to the service operation
312
341
  */
313
342
  listAllConnectHarnessesResponses(request: requests.ListConnectHarnessesRequest): AsyncIterableIterator<responses.ListConnectHarnessesResponse>;
343
+ /**
344
+ * Creates a new async iterator which will iterate over the models.ConnectHarnessSummary objects
345
+ * contained in responses from the listConnectHarnesses operation. This iterator will fetch more data from the
346
+ * server as needed.
347
+ *
348
+ * @param request a request which can be sent to the service operation
349
+ */
350
+ listConnectHarnessesRecordIterator(request: requests.ListConnectHarnessesRequest): AsyncIterableIterator<model.ConnectHarnessSummary>;
351
+ /**
352
+ * Creates a new async iterator which will iterate over the responses received from the listConnectHarnesses operation. This iterator
353
+ * will fetch more data from the server as needed.
354
+ *
355
+ * @param request a request which can be sent to the service operation
356
+ */
357
+ listConnectHarnessesResponseIterator(request: requests.ListConnectHarnessesRequest): AsyncIterableIterator<responses.ListConnectHarnessesResponse>;
314
358
  /**
315
359
  * List the stream pools for a given compartment ID.
360
+ * This operation does not retry by default if the user has not defined a retry configuration.
316
361
  * @param ListStreamPoolsRequest
317
362
  * @return ListStreamPoolsResponse
318
363
  * @throws OciError when an error occurs
319
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/ListStreamPools.ts.html |here} to see how to use ListStreamPools API.
364
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/ListStreamPools.ts.html |here} to see how to use ListStreamPools API.
320
365
  */
321
366
  listStreamPools(listStreamPoolsRequest: requests.ListStreamPoolsRequest): Promise<responses.ListStreamPoolsResponse>;
322
367
  /**
368
+ * NOTE: This function is deprecated in favor of listStreamPoolsRecordIterator function.
323
369
  * Creates a new async iterator which will iterate over the models.StreamPoolSummary objects
324
370
  * contained in responses from the listStreamPools operation. This iterator will fetch more data from the
325
371
  * server as needed.
@@ -328,25 +374,43 @@ export declare class StreamAdminClient {
328
374
  */
329
375
  listAllStreamPools(request: requests.ListStreamPoolsRequest): AsyncIterableIterator<model.StreamPoolSummary>;
330
376
  /**
377
+ * NOTE: This function is deprecated in favor of listStreamPoolsResponseIterator function.
331
378
  * Creates a new async iterator which will iterate over the responses received from the listStreamPools operation. This iterator
332
379
  * will fetch more data from the server as needed.
333
380
  *
334
381
  * @param request a request which can be sent to the service operation
335
382
  */
336
383
  listAllStreamPoolsResponses(request: requests.ListStreamPoolsRequest): AsyncIterableIterator<responses.ListStreamPoolsResponse>;
384
+ /**
385
+ * Creates a new async iterator which will iterate over the models.StreamPoolSummary objects
386
+ * contained in responses from the listStreamPools operation. This iterator will fetch more data from the
387
+ * server as needed.
388
+ *
389
+ * @param request a request which can be sent to the service operation
390
+ */
391
+ listStreamPoolsRecordIterator(request: requests.ListStreamPoolsRequest): AsyncIterableIterator<model.StreamPoolSummary>;
392
+ /**
393
+ * Creates a new async iterator which will iterate over the responses received from the listStreamPools operation. This iterator
394
+ * will fetch more data from the server as needed.
395
+ *
396
+ * @param request a request which can be sent to the service operation
397
+ */
398
+ listStreamPoolsResponseIterator(request: requests.ListStreamPoolsRequest): AsyncIterableIterator<responses.ListStreamPoolsResponse>;
337
399
  /**
338
400
  * Lists the streams in the given compartment id.
339
401
  * If the compartment id is specified, it will list streams in the compartment, regardless of their stream pool.
340
402
  * If the stream pool id is specified, the action will be scoped to that stream pool.
341
403
  * The compartment id and stream pool id cannot be specified at the same time.
342
404
  *
405
+ * This operation does not retry by default if the user has not defined a retry configuration.
343
406
  * @param ListStreamsRequest
344
407
  * @return ListStreamsResponse
345
408
  * @throws OciError when an error occurs
346
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/ListStreams.ts.html |here} to see how to use ListStreams API.
409
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/ListStreams.ts.html |here} to see how to use ListStreams API.
347
410
  */
348
411
  listStreams(listStreamsRequest: requests.ListStreamsRequest): Promise<responses.ListStreamsResponse>;
349
412
  /**
413
+ * NOTE: This function is deprecated in favor of listStreamsRecordIterator function.
350
414
  * Creates a new async iterator which will iterate over the models.StreamSummary objects
351
415
  * contained in responses from the listStreams operation. This iterator will fetch more data from the
352
416
  * server as needed.
@@ -355,37 +419,56 @@ export declare class StreamAdminClient {
355
419
  */
356
420
  listAllStreams(request: requests.ListStreamsRequest): AsyncIterableIterator<model.StreamSummary>;
357
421
  /**
422
+ * NOTE: This function is deprecated in favor of listStreamsResponseIterator function.
358
423
  * Creates a new async iterator which will iterate over the responses received from the listStreams operation. This iterator
359
424
  * will fetch more data from the server as needed.
360
425
  *
361
426
  * @param request a request which can be sent to the service operation
362
427
  */
363
428
  listAllStreamsResponses(request: requests.ListStreamsRequest): AsyncIterableIterator<responses.ListStreamsResponse>;
429
+ /**
430
+ * Creates a new async iterator which will iterate over the models.StreamSummary objects
431
+ * contained in responses from the listStreams operation. This iterator will fetch more data from the
432
+ * server as needed.
433
+ *
434
+ * @param request a request which can be sent to the service operation
435
+ */
436
+ listStreamsRecordIterator(request: requests.ListStreamsRequest): AsyncIterableIterator<model.StreamSummary>;
437
+ /**
438
+ * Creates a new async iterator which will iterate over the responses received from the listStreams operation. This iterator
439
+ * will fetch more data from the server as needed.
440
+ *
441
+ * @param request a request which can be sent to the service operation
442
+ */
443
+ listStreamsResponseIterator(request: requests.ListStreamsRequest): AsyncIterableIterator<responses.ListStreamsResponse>;
364
444
  /**
365
445
  * Updates the tags applied to the connect harness.
366
446
  *
447
+ * This operation does not retry by default if the user has not defined a retry configuration.
367
448
  * @param UpdateConnectHarnessRequest
368
449
  * @return UpdateConnectHarnessResponse
369
450
  * @throws OciError when an error occurs
370
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/UpdateConnectHarness.ts.html |here} to see how to use UpdateConnectHarness API.
451
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/UpdateConnectHarness.ts.html |here} to see how to use UpdateConnectHarness API.
371
452
  */
372
453
  updateConnectHarness(updateConnectHarnessRequest: requests.UpdateConnectHarnessRequest): Promise<responses.UpdateConnectHarnessResponse>;
373
454
  /**
374
455
  * Updates the stream. Only specified values will be updated.
375
456
  *
457
+ * This operation does not retry by default if the user has not defined a retry configuration.
376
458
  * @param UpdateStreamRequest
377
459
  * @return UpdateStreamResponse
378
460
  * @throws OciError when an error occurs
379
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/UpdateStream.ts.html |here} to see how to use UpdateStream API.
461
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/UpdateStream.ts.html |here} to see how to use UpdateStream API.
380
462
  */
381
463
  updateStream(updateStreamRequest: requests.UpdateStreamRequest): Promise<responses.UpdateStreamResponse>;
382
464
  /**
383
465
  * Updates the specified stream pool.
384
466
  *
467
+ * This operation does not retry by default if the user has not defined a retry configuration.
385
468
  * @param UpdateStreamPoolRequest
386
469
  * @return UpdateStreamPoolResponse
387
470
  * @throws OciError when an error occurs
388
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/streaming/UpdateStreamPool.ts.html |here} to see how to use UpdateStreamPool API.
471
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/streaming/UpdateStreamPool.ts.html |here} to see how to use UpdateStreamPool API.
389
472
  */
390
473
  updateStreamPool(updateStreamPoolRequest: requests.UpdateStreamPoolRequest): Promise<responses.UpdateStreamPoolResponse>;
391
474
  }