oci-streaming 2.6.1 → 2.9.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.
- package/index.d.ts +2 -2
- package/index.js +2 -2
- package/lib/client.d.ts +54 -54
- package/lib/client.js +80 -80
- package/lib/client.js.map +1 -1
- package/lib/model/change-connect-harness-compartment-details.d.ts +2 -2
- package/lib/model/change-connect-harness-compartment-details.js +2 -2
- package/lib/model/change-stream-compartment-details.d.ts +2 -2
- package/lib/model/change-stream-compartment-details.js +2 -2
- package/lib/model/change-stream-pool-compartment-details.d.ts +2 -2
- package/lib/model/change-stream-pool-compartment-details.js +2 -2
- package/lib/model/connect-harness-summary.d.ts +2 -2
- package/lib/model/connect-harness-summary.js +2 -2
- package/lib/model/connect-harness.d.ts +2 -2
- package/lib/model/connect-harness.js +2 -2
- package/lib/model/create-connect-harness-details.d.ts +2 -2
- package/lib/model/create-connect-harness-details.js +2 -2
- package/lib/model/create-cursor-details.d.ts +2 -2
- package/lib/model/create-cursor-details.js +2 -2
- package/lib/model/create-group-cursor-details.d.ts +2 -2
- package/lib/model/create-group-cursor-details.js +2 -2
- package/lib/model/create-stream-details.d.ts +2 -2
- package/lib/model/create-stream-details.js +2 -2
- package/lib/model/create-stream-pool-details.d.ts +2 -2
- package/lib/model/create-stream-pool-details.js +2 -2
- package/lib/model/cursor.d.ts +2 -2
- package/lib/model/cursor.js +2 -2
- package/lib/model/custom-encryption-key-details.d.ts +2 -2
- package/lib/model/custom-encryption-key-details.js +2 -2
- package/lib/model/custom-encryption-key.d.ts +2 -2
- package/lib/model/custom-encryption-key.js +2 -2
- package/lib/model/group.d.ts +2 -2
- package/lib/model/group.js +2 -2
- package/lib/model/index.d.ts +2 -2
- package/lib/model/index.js +2 -2
- package/lib/model/kafka-settings.d.ts +2 -2
- package/lib/model/kafka-settings.js +2 -2
- package/lib/model/message.d.ts +2 -2
- package/lib/model/message.js +2 -2
- package/lib/model/partition-reservation.d.ts +2 -2
- package/lib/model/partition-reservation.js +2 -2
- package/lib/model/private-endpoint-details.d.ts +2 -2
- package/lib/model/private-endpoint-details.js +2 -2
- package/lib/model/private-endpoint-settings.d.ts +2 -2
- package/lib/model/private-endpoint-settings.js +2 -2
- package/lib/model/put-messages-details-entry.d.ts +2 -2
- package/lib/model/put-messages-details-entry.js +2 -2
- package/lib/model/put-messages-details.d.ts +2 -2
- package/lib/model/put-messages-details.js +2 -2
- package/lib/model/put-messages-result-entry.d.ts +2 -2
- package/lib/model/put-messages-result-entry.js +2 -2
- package/lib/model/put-messages-result.d.ts +2 -2
- package/lib/model/put-messages-result.js +2 -2
- package/lib/model/stream-pool-summary.d.ts +2 -2
- package/lib/model/stream-pool-summary.js +2 -2
- package/lib/model/stream-pool.d.ts +2 -2
- package/lib/model/stream-pool.js +2 -2
- package/lib/model/stream-summary.d.ts +2 -2
- package/lib/model/stream-summary.js +2 -2
- package/lib/model/stream.d.ts +2 -2
- package/lib/model/stream.js +2 -2
- package/lib/model/update-connect-harness-details.d.ts +2 -2
- package/lib/model/update-connect-harness-details.js +2 -2
- package/lib/model/update-group-details.d.ts +2 -2
- package/lib/model/update-group-details.js +2 -2
- package/lib/model/update-stream-details.d.ts +2 -2
- package/lib/model/update-stream-details.js +2 -2
- package/lib/model/update-stream-pool-details.d.ts +2 -2
- package/lib/model/update-stream-pool-details.js +2 -2
- package/lib/request/change-connect-harness-compartment-request.d.ts +1 -1
- package/lib/request/change-stream-compartment-request.d.ts +1 -1
- package/lib/request/change-stream-pool-compartment-request.d.ts +1 -1
- package/lib/request/consumer-commit-request.d.ts +1 -1
- package/lib/request/consumer-heartbeat-request.d.ts +1 -1
- package/lib/request/create-connect-harness-request.d.ts +1 -1
- package/lib/request/create-cursor-request.d.ts +1 -1
- package/lib/request/create-group-cursor-request.d.ts +1 -1
- package/lib/request/create-stream-pool-request.d.ts +1 -1
- package/lib/request/create-stream-request.d.ts +1 -1
- package/lib/request/delete-connect-harness-request.d.ts +1 -1
- package/lib/request/delete-stream-pool-request.d.ts +1 -1
- package/lib/request/delete-stream-request.d.ts +1 -1
- package/lib/request/get-connect-harness-request.d.ts +1 -1
- package/lib/request/get-group-request.d.ts +1 -1
- package/lib/request/get-messages-request.d.ts +1 -1
- package/lib/request/get-stream-pool-request.d.ts +1 -1
- package/lib/request/get-stream-request.d.ts +1 -1
- package/lib/request/index.d.ts +2 -2
- package/lib/request/index.js +2 -2
- package/lib/request/list-connect-harnesses-request.d.ts +1 -1
- package/lib/request/list-stream-pools-request.d.ts +1 -1
- package/lib/request/list-streams-request.d.ts +1 -1
- package/lib/request/put-messages-request.d.ts +1 -1
- package/lib/request/update-connect-harness-request.d.ts +1 -1
- package/lib/request/update-group-request.d.ts +1 -1
- package/lib/request/update-stream-pool-request.d.ts +1 -1
- package/lib/request/update-stream-request.d.ts +1 -1
- package/lib/response/index.d.ts +2 -2
- package/lib/response/index.js +2 -2
- package/lib/streamadmin-waiter.d.ts +2 -2
- package/lib/streamadmin-waiter.js +2 -2
- package/package.json +3 -3
package/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Streaming
|
|
3
|
-
*
|
|
2
|
+
* Streaming API
|
|
3
|
+
* Use the Streaming API to produce and consume messages, create streams and stream pools, and manage related items. For more information, see [Streaming](/Content/Streaming/Concepts/streamingoverview.htm).
|
|
4
4
|
* OpenAPI spec version: 20180418
|
|
5
5
|
*
|
|
6
6
|
*
|
package/index.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
/**
|
|
3
|
-
* Streaming
|
|
4
|
-
*
|
|
3
|
+
* Streaming API
|
|
4
|
+
* Use the Streaming API to produce and consume messages, create streams and stream pools, and manage related items. For more information, see [Streaming](/Content/Streaming/Concepts/streamingoverview.htm).
|
|
5
5
|
* OpenAPI spec version: 20180418
|
|
6
6
|
*
|
|
7
7
|
*
|
package/lib/client.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Streaming
|
|
3
|
-
*
|
|
2
|
+
* Streaming API
|
|
3
|
+
* Use the Streaming API to produce and consume messages, create streams and stream pools, and manage related items. For more information, see [Streaming](/Content/Streaming/Concepts/streamingoverview.htm).
|
|
4
4
|
* OpenAPI spec version: 20180418
|
|
5
5
|
*
|
|
6
6
|
*
|
|
@@ -42,21 +42,21 @@ export declare class StreamClient {
|
|
|
42
42
|
* Provides a mechanism to manually commit offsets, if not using commit-on-get consumer semantics.
|
|
43
43
|
* This commits offsets assicated with the provided cursor, extends the timeout on each of the affected partitions, and returns an updated cursor.
|
|
44
44
|
*
|
|
45
|
-
* This operation
|
|
45
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
46
46
|
* @param ConsumerCommitRequest
|
|
47
47
|
* @return ConsumerCommitResponse
|
|
48
48
|
* @throws OciError when an error occurs
|
|
49
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
49
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/ConsumerCommit.ts.html |here} to see how to use ConsumerCommit API.
|
|
50
50
|
*/
|
|
51
51
|
consumerCommit(consumerCommitRequest: requests.ConsumerCommitRequest): Promise<responses.ConsumerCommitResponse>;
|
|
52
52
|
/**
|
|
53
53
|
* Allows long-running processes to extend the timeout on partitions reserved by a consumer instance.
|
|
54
54
|
*
|
|
55
|
-
* This operation
|
|
55
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
56
56
|
* @param ConsumerHeartbeatRequest
|
|
57
57
|
* @return ConsumerHeartbeatResponse
|
|
58
58
|
* @throws OciError when an error occurs
|
|
59
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
59
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/ConsumerHeartbeat.ts.html |here} to see how to use ConsumerHeartbeat API.
|
|
60
60
|
*/
|
|
61
61
|
consumerHeartbeat(consumerHeartbeatRequest: requests.ConsumerHeartbeatRequest): Promise<responses.ConsumerHeartbeatResponse>;
|
|
62
62
|
/**
|
|
@@ -66,31 +66,31 @@ export declare class StreamClient {
|
|
|
66
66
|
* on the most recent message allows consumption of only messages that are added to the stream after you create the cursor. Cursors expire
|
|
67
67
|
* five minutes after you receive them from the service.
|
|
68
68
|
*
|
|
69
|
-
* This operation
|
|
69
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
70
70
|
* @param CreateCursorRequest
|
|
71
71
|
* @return CreateCursorResponse
|
|
72
72
|
* @throws OciError when an error occurs
|
|
73
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
73
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/CreateCursor.ts.html |here} to see how to use CreateCursor API.
|
|
74
74
|
*/
|
|
75
75
|
createCursor(createCursorRequest: requests.CreateCursorRequest): Promise<responses.CreateCursorResponse>;
|
|
76
76
|
/**
|
|
77
77
|
* Creates a group-cursor.
|
|
78
78
|
*
|
|
79
|
-
* This operation
|
|
79
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
80
80
|
* @param CreateGroupCursorRequest
|
|
81
81
|
* @return CreateGroupCursorResponse
|
|
82
82
|
* @throws OciError when an error occurs
|
|
83
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
83
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/CreateGroupCursor.ts.html |here} to see how to use CreateGroupCursor API.
|
|
84
84
|
*/
|
|
85
85
|
createGroupCursor(createGroupCursorRequest: requests.CreateGroupCursorRequest): Promise<responses.CreateGroupCursorResponse>;
|
|
86
86
|
/**
|
|
87
87
|
* Returns the current state of a consumer group.
|
|
88
88
|
*
|
|
89
|
-
* This operation
|
|
89
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
90
90
|
* @param GetGroupRequest
|
|
91
91
|
* @return GetGroupResponse
|
|
92
92
|
* @throws OciError when an error occurs
|
|
93
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
93
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/GetGroup.ts.html |here} to see how to use GetGroup API.
|
|
94
94
|
*/
|
|
95
95
|
getGroup(getGroupRequest: requests.GetGroupRequest): Promise<responses.GetGroupResponse>;
|
|
96
96
|
/**
|
|
@@ -98,11 +98,11 @@ export declare class StreamClient {
|
|
|
98
98
|
* To get messages, you must first obtain a cursor using the {@link #createCursor(CreateCursorRequest) createCursor} operation.
|
|
99
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.
|
|
100
100
|
*
|
|
101
|
-
* This operation
|
|
101
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
102
102
|
* @param GetMessagesRequest
|
|
103
103
|
* @return GetMessagesResponse
|
|
104
104
|
* @throws OciError when an error occurs
|
|
105
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
105
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/GetMessages.ts.html |here} to see how to use GetMessages API.
|
|
106
106
|
*/
|
|
107
107
|
getMessages(getMessagesRequest: requests.GetMessagesRequest): Promise<responses.GetMessagesResponse>;
|
|
108
108
|
/**
|
|
@@ -115,24 +115,24 @@ export declare class StreamClient {
|
|
|
115
115
|
* @param PutMessagesRequest
|
|
116
116
|
* @return PutMessagesResponse
|
|
117
117
|
* @throws OciError when an error occurs
|
|
118
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
118
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/PutMessages.ts.html |here} to see how to use PutMessages API.
|
|
119
119
|
*/
|
|
120
120
|
putMessages(putMessagesRequest: requests.PutMessagesRequest): Promise<responses.PutMessagesResponse>;
|
|
121
121
|
/**
|
|
122
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.
|
|
123
123
|
*
|
|
124
|
-
* This operation
|
|
124
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
125
125
|
* @param UpdateGroupRequest
|
|
126
126
|
* @return UpdateGroupResponse
|
|
127
127
|
* @throws OciError when an error occurs
|
|
128
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
128
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/UpdateGroup.ts.html |here} to see how to use UpdateGroup API.
|
|
129
129
|
*/
|
|
130
130
|
updateGroup(updateGroupRequest: requests.UpdateGroupRequest): Promise<responses.UpdateGroupResponse>;
|
|
131
131
|
}
|
|
132
132
|
export declare enum StreamAdminApiKeys {
|
|
133
133
|
}
|
|
134
134
|
/**
|
|
135
|
-
* This service client
|
|
135
|
+
* This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
|
|
136
136
|
*/
|
|
137
137
|
export declare class StreamAdminClient {
|
|
138
138
|
protected static serviceEndpointTemplate: string;
|
|
@@ -183,11 +183,11 @@ export declare class StreamAdminClient {
|
|
|
183
183
|
getWaiters(): StreamAdminWaiter;
|
|
184
184
|
/**
|
|
185
185
|
* Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
|
|
186
|
-
* This operation
|
|
186
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
187
187
|
* @param ChangeConnectHarnessCompartmentRequest
|
|
188
188
|
* @return ChangeConnectHarnessCompartmentResponse
|
|
189
189
|
* @throws OciError when an error occurs
|
|
190
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
190
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/ChangeConnectHarnessCompartment.ts.html |here} to see how to use ChangeConnectHarnessCompartment API.
|
|
191
191
|
*/
|
|
192
192
|
changeConnectHarnessCompartment(changeConnectHarnessCompartmentRequest: requests.ChangeConnectHarnessCompartmentRequest): Promise<responses.ChangeConnectHarnessCompartmentResponse>;
|
|
193
193
|
/**
|
|
@@ -195,31 +195,31 @@ export declare class StreamAdminClient {
|
|
|
195
195
|
* When provided, If-Match is checked against ETag values of the resource.
|
|
196
196
|
* The stream will also be moved into the default stream pool in the destination compartment.
|
|
197
197
|
*
|
|
198
|
-
* This operation
|
|
198
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
199
199
|
* @param ChangeStreamCompartmentRequest
|
|
200
200
|
* @return ChangeStreamCompartmentResponse
|
|
201
201
|
* @throws OciError when an error occurs
|
|
202
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
202
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/ChangeStreamCompartment.ts.html |here} to see how to use ChangeStreamCompartment API.
|
|
203
203
|
*/
|
|
204
204
|
changeStreamCompartment(changeStreamCompartmentRequest: requests.ChangeStreamCompartmentRequest): Promise<responses.ChangeStreamCompartmentResponse>;
|
|
205
205
|
/**
|
|
206
206
|
* Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
|
|
207
|
-
* This operation
|
|
207
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
208
208
|
* @param ChangeStreamPoolCompartmentRequest
|
|
209
209
|
* @return ChangeStreamPoolCompartmentResponse
|
|
210
210
|
* @throws OciError when an error occurs
|
|
211
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
211
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/ChangeStreamPoolCompartment.ts.html |here} to see how to use ChangeStreamPoolCompartment API.
|
|
212
212
|
*/
|
|
213
213
|
changeStreamPoolCompartment(changeStreamPoolCompartmentRequest: requests.ChangeStreamPoolCompartmentRequest): Promise<responses.ChangeStreamPoolCompartmentResponse>;
|
|
214
214
|
/**
|
|
215
215
|
* Starts the provisioning of a new connect harness.
|
|
216
216
|
* To track the progress of the provisioning, you can periodically call {@link ConnectHarness} object tells you its current state.
|
|
217
217
|
*
|
|
218
|
-
* This operation
|
|
218
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
219
219
|
* @param CreateConnectHarnessRequest
|
|
220
220
|
* @return CreateConnectHarnessResponse
|
|
221
221
|
* @throws OciError when an error occurs
|
|
222
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
222
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/CreateConnectHarness.ts.html |here} to see how to use CreateConnectHarness API.
|
|
223
223
|
*/
|
|
224
224
|
createConnectHarness(createConnectHarnessRequest: requests.CreateConnectHarnessRequest): Promise<responses.CreateConnectHarnessResponse>;
|
|
225
225
|
/**
|
|
@@ -229,11 +229,11 @@ export declare class StreamAdminClient {
|
|
|
229
229
|
* To track the progress of the provisioning, you can periodically call {@link #getStream(GetStreamRequest) getStream}.
|
|
230
230
|
* In the response, the `lifecycleState` parameter of the {@link Stream} object tells you its current state.
|
|
231
231
|
*
|
|
232
|
-
* This operation
|
|
232
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
233
233
|
* @param CreateStreamRequest
|
|
234
234
|
* @return CreateStreamResponse
|
|
235
235
|
* @throws OciError when an error occurs
|
|
236
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
236
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/CreateStream.ts.html |here} to see how to use CreateStream API.
|
|
237
237
|
*/
|
|
238
238
|
createStream(createStreamRequest: requests.CreateStreamRequest): Promise<responses.CreateStreamResponse>;
|
|
239
239
|
/**
|
|
@@ -241,11 +241,11 @@ export declare class StreamAdminClient {
|
|
|
241
241
|
* To track the progress of the provisioning, you can periodically call GetStreamPool.
|
|
242
242
|
* In the response, the `lifecycleState` parameter of the object tells you its current state.
|
|
243
243
|
*
|
|
244
|
-
* This operation
|
|
244
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
245
245
|
* @param CreateStreamPoolRequest
|
|
246
246
|
* @return CreateStreamPoolResponse
|
|
247
247
|
* @throws OciError when an error occurs
|
|
248
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
248
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/CreateStreamPool.ts.html |here} to see how to use CreateStreamPool API.
|
|
249
249
|
*/
|
|
250
250
|
createStreamPool(createStreamPoolRequest: requests.CreateStreamPoolRequest): Promise<responses.CreateStreamPoolResponse>;
|
|
251
251
|
/**
|
|
@@ -255,11 +255,11 @@ export declare class StreamAdminClient {
|
|
|
255
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
|
|
256
256
|
* connect harness have been deleted.
|
|
257
257
|
*
|
|
258
|
-
* This operation
|
|
258
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
259
259
|
* @param DeleteConnectHarnessRequest
|
|
260
260
|
* @return DeleteConnectHarnessResponse
|
|
261
261
|
* @throws OciError when an error occurs
|
|
262
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
262
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/DeleteConnectHarness.ts.html |here} to see how to use DeleteConnectHarness API.
|
|
263
263
|
*/
|
|
264
264
|
deleteConnectHarness(deleteConnectHarnessRequest: requests.DeleteConnectHarnessRequest): Promise<responses.DeleteConnectHarnessResponse>;
|
|
265
265
|
/**
|
|
@@ -269,58 +269,58 @@ export declare class StreamAdminClient {
|
|
|
269
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
|
|
270
270
|
* stream have been deleted.
|
|
271
271
|
*
|
|
272
|
-
* This operation
|
|
272
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
273
273
|
* @param DeleteStreamRequest
|
|
274
274
|
* @return DeleteStreamResponse
|
|
275
275
|
* @throws OciError when an error occurs
|
|
276
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
276
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/DeleteStream.ts.html |here} to see how to use DeleteStream API.
|
|
277
277
|
*/
|
|
278
278
|
deleteStream(deleteStreamRequest: requests.DeleteStreamRequest): Promise<responses.DeleteStreamResponse>;
|
|
279
279
|
/**
|
|
280
280
|
* Deletes a stream pool. All containing streams will also be deleted.
|
|
281
281
|
* The default stream pool of a compartment cannot be deleted.
|
|
282
282
|
*
|
|
283
|
-
* This operation
|
|
283
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
284
284
|
* @param DeleteStreamPoolRequest
|
|
285
285
|
* @return DeleteStreamPoolResponse
|
|
286
286
|
* @throws OciError when an error occurs
|
|
287
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
287
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/DeleteStreamPool.ts.html |here} to see how to use DeleteStreamPool API.
|
|
288
288
|
*/
|
|
289
289
|
deleteStreamPool(deleteStreamPoolRequest: requests.DeleteStreamPoolRequest): Promise<responses.DeleteStreamPoolResponse>;
|
|
290
290
|
/**
|
|
291
291
|
* Gets detailed information about a connect harness.
|
|
292
|
-
* This operation
|
|
292
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
293
293
|
* @param GetConnectHarnessRequest
|
|
294
294
|
* @return GetConnectHarnessResponse
|
|
295
295
|
* @throws OciError when an error occurs
|
|
296
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
296
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/GetConnectHarness.ts.html |here} to see how to use GetConnectHarness API.
|
|
297
297
|
*/
|
|
298
298
|
getConnectHarness(getConnectHarnessRequest: requests.GetConnectHarnessRequest): Promise<responses.GetConnectHarnessResponse>;
|
|
299
299
|
/**
|
|
300
300
|
* Gets detailed information about a stream, including the number of partitions.
|
|
301
|
-
* This operation
|
|
301
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
302
302
|
* @param GetStreamRequest
|
|
303
303
|
* @return GetStreamResponse
|
|
304
304
|
* @throws OciError when an error occurs
|
|
305
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
305
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/GetStream.ts.html |here} to see how to use GetStream API.
|
|
306
306
|
*/
|
|
307
307
|
getStream(getStreamRequest: requests.GetStreamRequest): Promise<responses.GetStreamResponse>;
|
|
308
308
|
/**
|
|
309
309
|
* Gets detailed information about the stream pool, such as Kafka settings.
|
|
310
|
-
* This operation
|
|
310
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
311
311
|
* @param GetStreamPoolRequest
|
|
312
312
|
* @return GetStreamPoolResponse
|
|
313
313
|
* @throws OciError when an error occurs
|
|
314
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
314
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/GetStreamPool.ts.html |here} to see how to use GetStreamPool API.
|
|
315
315
|
*/
|
|
316
316
|
getStreamPool(getStreamPoolRequest: requests.GetStreamPoolRequest): Promise<responses.GetStreamPoolResponse>;
|
|
317
317
|
/**
|
|
318
318
|
* Lists the connectharness.
|
|
319
|
-
* This operation
|
|
319
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
320
320
|
* @param ListConnectHarnessesRequest
|
|
321
321
|
* @return ListConnectHarnessesResponse
|
|
322
322
|
* @throws OciError when an error occurs
|
|
323
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
323
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/ListConnectHarnesses.ts.html |here} to see how to use ListConnectHarnesses API.
|
|
324
324
|
*/
|
|
325
325
|
listConnectHarnesses(listConnectHarnessesRequest: requests.ListConnectHarnessesRequest): Promise<responses.ListConnectHarnessesResponse>;
|
|
326
326
|
/**
|
|
@@ -357,11 +357,11 @@ export declare class StreamAdminClient {
|
|
|
357
357
|
listConnectHarnessesResponseIterator(request: requests.ListConnectHarnessesRequest): AsyncIterableIterator<responses.ListConnectHarnessesResponse>;
|
|
358
358
|
/**
|
|
359
359
|
* List the stream pools for a given compartment ID.
|
|
360
|
-
* This operation
|
|
360
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
361
361
|
* @param ListStreamPoolsRequest
|
|
362
362
|
* @return ListStreamPoolsResponse
|
|
363
363
|
* @throws OciError when an error occurs
|
|
364
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
364
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/ListStreamPools.ts.html |here} to see how to use ListStreamPools API.
|
|
365
365
|
*/
|
|
366
366
|
listStreamPools(listStreamPoolsRequest: requests.ListStreamPoolsRequest): Promise<responses.ListStreamPoolsResponse>;
|
|
367
367
|
/**
|
|
@@ -402,11 +402,11 @@ export declare class StreamAdminClient {
|
|
|
402
402
|
* If the stream pool id is specified, the action will be scoped to that stream pool.
|
|
403
403
|
* The compartment id and stream pool id cannot be specified at the same time.
|
|
404
404
|
*
|
|
405
|
-
* This operation
|
|
405
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
406
406
|
* @param ListStreamsRequest
|
|
407
407
|
* @return ListStreamsResponse
|
|
408
408
|
* @throws OciError when an error occurs
|
|
409
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
409
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/ListStreams.ts.html |here} to see how to use ListStreams API.
|
|
410
410
|
*/
|
|
411
411
|
listStreams(listStreamsRequest: requests.ListStreamsRequest): Promise<responses.ListStreamsResponse>;
|
|
412
412
|
/**
|
|
@@ -444,31 +444,31 @@ export declare class StreamAdminClient {
|
|
|
444
444
|
/**
|
|
445
445
|
* Updates the tags applied to the connect harness.
|
|
446
446
|
*
|
|
447
|
-
* This operation
|
|
447
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
448
448
|
* @param UpdateConnectHarnessRequest
|
|
449
449
|
* @return UpdateConnectHarnessResponse
|
|
450
450
|
* @throws OciError when an error occurs
|
|
451
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
451
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/UpdateConnectHarness.ts.html |here} to see how to use UpdateConnectHarness API.
|
|
452
452
|
*/
|
|
453
453
|
updateConnectHarness(updateConnectHarnessRequest: requests.UpdateConnectHarnessRequest): Promise<responses.UpdateConnectHarnessResponse>;
|
|
454
454
|
/**
|
|
455
455
|
* Updates the stream. Only specified values will be updated.
|
|
456
456
|
*
|
|
457
|
-
* This operation
|
|
457
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
458
458
|
* @param UpdateStreamRequest
|
|
459
459
|
* @return UpdateStreamResponse
|
|
460
460
|
* @throws OciError when an error occurs
|
|
461
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
461
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/UpdateStream.ts.html |here} to see how to use UpdateStream API.
|
|
462
462
|
*/
|
|
463
463
|
updateStream(updateStreamRequest: requests.UpdateStreamRequest): Promise<responses.UpdateStreamResponse>;
|
|
464
464
|
/**
|
|
465
465
|
* Updates the specified stream pool.
|
|
466
466
|
*
|
|
467
|
-
* This operation
|
|
467
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
468
468
|
* @param UpdateStreamPoolRequest
|
|
469
469
|
* @return UpdateStreamPoolResponse
|
|
470
470
|
* @throws OciError when an error occurs
|
|
471
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
471
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.9.1/streaming/UpdateStreamPool.ts.html |here} to see how to use UpdateStreamPool API.
|
|
472
472
|
*/
|
|
473
473
|
updateStreamPool(updateStreamPoolRequest: requests.UpdateStreamPoolRequest): Promise<responses.UpdateStreamPoolResponse>;
|
|
474
474
|
}
|