oci-dataflow 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.
- package/LICENSE.txt +6 -0
- package/lib/client.d.ts +102 -24
- package/lib/client.js +170 -49
- package/lib/client.js.map +1 -1
- package/lib/request/change-application-compartment-request.d.ts +1 -1
- package/lib/request/change-private-endpoint-compartment-request.d.ts +1 -1
- package/lib/request/change-run-compartment-request.d.ts +1 -1
- package/lib/request/create-application-request.d.ts +1 -1
- package/lib/request/create-private-endpoint-request.d.ts +1 -1
- package/lib/request/create-run-request.d.ts +1 -1
- package/lib/request/delete-application-request.d.ts +1 -1
- package/lib/request/delete-private-endpoint-request.d.ts +1 -1
- package/lib/request/delete-run-request.d.ts +1 -1
- package/lib/request/get-application-request.d.ts +1 -1
- package/lib/request/get-private-endpoint-request.d.ts +1 -1
- package/lib/request/get-run-log-request.d.ts +1 -1
- package/lib/request/get-run-request.d.ts +1 -1
- package/lib/request/get-work-request-request.d.ts +1 -1
- package/lib/request/list-applications-request.d.ts +1 -1
- package/lib/request/list-private-endpoints-request.d.ts +1 -1
- package/lib/request/list-run-logs-request.d.ts +1 -1
- package/lib/request/list-runs-request.d.ts +1 -1
- package/lib/request/list-work-request-errors-request.d.ts +1 -1
- package/lib/request/list-work-request-logs-request.d.ts +1 -1
- package/lib/request/list-work-requests-request.d.ts +1 -1
- package/lib/request/update-application-request.d.ts +1 -1
- package/lib/request/update-private-endpoint-request.d.ts +1 -1
- package/lib/request/update-run-request.d.ts +1 -1
- 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
|
@@ -18,6 +18,9 @@ import * as responses from "./response";
|
|
|
18
18
|
import { DataFlowWaiter } from "./dataflow-waiter";
|
|
19
19
|
export declare enum DataFlowApiKeys {
|
|
20
20
|
}
|
|
21
|
+
/**
|
|
22
|
+
* This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.
|
|
23
|
+
*/
|
|
21
24
|
export declare class DataFlowClient {
|
|
22
25
|
protected static serviceEndpointTemplate: string;
|
|
23
26
|
protected "_endpoint": string;
|
|
@@ -69,19 +72,21 @@ export declare class DataFlowClient {
|
|
|
69
72
|
* Moves an application into a different compartment. When provided, If-Match is checked against ETag values of the resource.
|
|
70
73
|
* Associated resources, like runs, will not be automatically moved.
|
|
71
74
|
*
|
|
75
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
72
76
|
* @param ChangeApplicationCompartmentRequest
|
|
73
77
|
* @return ChangeApplicationCompartmentResponse
|
|
74
78
|
* @throws OciError when an error occurs
|
|
75
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
79
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/ChangeApplicationCompartment.ts.html |here} to see how to use ChangeApplicationCompartment API.
|
|
76
80
|
*/
|
|
77
81
|
changeApplicationCompartment(changeApplicationCompartmentRequest: requests.ChangeApplicationCompartmentRequest): Promise<responses.ChangeApplicationCompartmentResponse>;
|
|
78
82
|
/**
|
|
79
83
|
* Moves a private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.
|
|
80
84
|
*
|
|
85
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
81
86
|
* @param ChangePrivateEndpointCompartmentRequest
|
|
82
87
|
* @return ChangePrivateEndpointCompartmentResponse
|
|
83
88
|
* @throws OciError when an error occurs
|
|
84
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
89
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/ChangePrivateEndpointCompartment.ts.html |here} to see how to use ChangePrivateEndpointCompartment API.
|
|
85
90
|
*/
|
|
86
91
|
changePrivateEndpointCompartment(changePrivateEndpointCompartmentRequest: requests.ChangePrivateEndpointCompartmentRequest): Promise<responses.ChangePrivateEndpointCompartmentResponse>;
|
|
87
92
|
/**
|
|
@@ -90,122 +95,136 @@ export declare class DataFlowClient {
|
|
|
90
95
|
* automatically moved. The run must be in a terminal state (CANCELED, FAILED, SUCCEEDED) in
|
|
91
96
|
* order for it to be moved to a different compartment
|
|
92
97
|
*
|
|
98
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
93
99
|
* @param ChangeRunCompartmentRequest
|
|
94
100
|
* @return ChangeRunCompartmentResponse
|
|
95
101
|
* @throws OciError when an error occurs
|
|
96
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
102
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/ChangeRunCompartment.ts.html |here} to see how to use ChangeRunCompartment API.
|
|
97
103
|
*/
|
|
98
104
|
changeRunCompartment(changeRunCompartmentRequest: requests.ChangeRunCompartmentRequest): Promise<responses.ChangeRunCompartmentResponse>;
|
|
99
105
|
/**
|
|
100
106
|
* Creates an application.
|
|
101
107
|
*
|
|
108
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
102
109
|
* @param CreateApplicationRequest
|
|
103
110
|
* @return CreateApplicationResponse
|
|
104
111
|
* @throws OciError when an error occurs
|
|
105
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
112
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/CreateApplication.ts.html |here} to see how to use CreateApplication API.
|
|
106
113
|
*/
|
|
107
114
|
createApplication(createApplicationRequest: requests.CreateApplicationRequest): Promise<responses.CreateApplicationResponse>;
|
|
108
115
|
/**
|
|
109
116
|
* Creates a private endpoint to be used by applications.
|
|
110
117
|
*
|
|
118
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
111
119
|
* @param CreatePrivateEndpointRequest
|
|
112
120
|
* @return CreatePrivateEndpointResponse
|
|
113
121
|
* @throws OciError when an error occurs
|
|
114
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
122
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/CreatePrivateEndpoint.ts.html |here} to see how to use CreatePrivateEndpoint API.
|
|
115
123
|
*/
|
|
116
124
|
createPrivateEndpoint(createPrivateEndpointRequest: requests.CreatePrivateEndpointRequest): Promise<responses.CreatePrivateEndpointResponse>;
|
|
117
125
|
/**
|
|
118
126
|
* Creates a run for an application.
|
|
119
127
|
*
|
|
128
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
120
129
|
* @param CreateRunRequest
|
|
121
130
|
* @return CreateRunResponse
|
|
122
131
|
* @throws OciError when an error occurs
|
|
123
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
132
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/CreateRun.ts.html |here} to see how to use CreateRun API.
|
|
124
133
|
*/
|
|
125
134
|
createRun(createRunRequest: requests.CreateRunRequest): Promise<responses.CreateRunResponse>;
|
|
126
135
|
/**
|
|
127
136
|
* Deletes an application using an `applicationId`.
|
|
128
137
|
*
|
|
138
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
129
139
|
* @param DeleteApplicationRequest
|
|
130
140
|
* @return DeleteApplicationResponse
|
|
131
141
|
* @throws OciError when an error occurs
|
|
132
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
142
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/DeleteApplication.ts.html |here} to see how to use DeleteApplication API.
|
|
133
143
|
*/
|
|
134
144
|
deleteApplication(deleteApplicationRequest: requests.DeleteApplicationRequest): Promise<responses.DeleteApplicationResponse>;
|
|
135
145
|
/**
|
|
136
146
|
* Deletes a private endpoint using a `privateEndpointId`.
|
|
137
147
|
*
|
|
148
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
138
149
|
* @param DeletePrivateEndpointRequest
|
|
139
150
|
* @return DeletePrivateEndpointResponse
|
|
140
151
|
* @throws OciError when an error occurs
|
|
141
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
152
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/DeletePrivateEndpoint.ts.html |here} to see how to use DeletePrivateEndpoint API.
|
|
142
153
|
*/
|
|
143
154
|
deletePrivateEndpoint(deletePrivateEndpointRequest: requests.DeletePrivateEndpointRequest): Promise<responses.DeletePrivateEndpointResponse>;
|
|
144
155
|
/**
|
|
145
156
|
* Cancels the specified run if it has not already completed or was previously cancelled.
|
|
146
157
|
* If a run is in progress, the executing job will be killed.
|
|
147
158
|
*
|
|
159
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
148
160
|
* @param DeleteRunRequest
|
|
149
161
|
* @return DeleteRunResponse
|
|
150
162
|
* @throws OciError when an error occurs
|
|
151
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
163
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/DeleteRun.ts.html |here} to see how to use DeleteRun API.
|
|
152
164
|
*/
|
|
153
165
|
deleteRun(deleteRunRequest: requests.DeleteRunRequest): Promise<responses.DeleteRunResponse>;
|
|
154
166
|
/**
|
|
155
167
|
* Retrieves an application using an `applicationId`.
|
|
156
168
|
*
|
|
169
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
157
170
|
* @param GetApplicationRequest
|
|
158
171
|
* @return GetApplicationResponse
|
|
159
172
|
* @throws OciError when an error occurs
|
|
160
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
173
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/GetApplication.ts.html |here} to see how to use GetApplication API.
|
|
161
174
|
*/
|
|
162
175
|
getApplication(getApplicationRequest: requests.GetApplicationRequest): Promise<responses.GetApplicationResponse>;
|
|
163
176
|
/**
|
|
164
177
|
* Retrieves an private endpoint using a `privateEndpointId`.
|
|
165
178
|
*
|
|
179
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
166
180
|
* @param GetPrivateEndpointRequest
|
|
167
181
|
* @return GetPrivateEndpointResponse
|
|
168
182
|
* @throws OciError when an error occurs
|
|
169
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
183
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/GetPrivateEndpoint.ts.html |here} to see how to use GetPrivateEndpoint API.
|
|
170
184
|
*/
|
|
171
185
|
getPrivateEndpoint(getPrivateEndpointRequest: requests.GetPrivateEndpointRequest): Promise<responses.GetPrivateEndpointResponse>;
|
|
172
186
|
/**
|
|
173
187
|
* Retrieves the run for the specified `runId`.
|
|
174
188
|
*
|
|
189
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
175
190
|
* @param GetRunRequest
|
|
176
191
|
* @return GetRunResponse
|
|
177
192
|
* @throws OciError when an error occurs
|
|
178
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
193
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/GetRun.ts.html |here} to see how to use GetRun API.
|
|
179
194
|
*/
|
|
180
195
|
getRun(getRunRequest: requests.GetRunRequest): Promise<responses.GetRunResponse>;
|
|
181
196
|
/**
|
|
182
197
|
* Retrieves the content of an run log.
|
|
183
198
|
*
|
|
199
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
184
200
|
* @param GetRunLogRequest
|
|
185
201
|
* @return GetRunLogResponse
|
|
186
202
|
* @throws OciError when an error occurs
|
|
187
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
203
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/GetRunLog.ts.html |here} to see how to use GetRunLog API.
|
|
188
204
|
*/
|
|
189
205
|
getRunLog(getRunLogRequest: requests.GetRunLogRequest): Promise<responses.GetRunLogResponse>;
|
|
190
206
|
/**
|
|
191
207
|
* Gets the status of the work request with the given OCID.
|
|
192
208
|
*
|
|
209
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
193
210
|
* @param GetWorkRequestRequest
|
|
194
211
|
* @return GetWorkRequestResponse
|
|
195
212
|
* @throws OciError when an error occurs
|
|
196
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
213
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
|
|
197
214
|
*/
|
|
198
215
|
getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
|
|
199
216
|
/**
|
|
200
217
|
* Lists all applications in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.
|
|
201
218
|
*
|
|
219
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
202
220
|
* @param ListApplicationsRequest
|
|
203
221
|
* @return ListApplicationsResponse
|
|
204
222
|
* @throws OciError when an error occurs
|
|
205
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
223
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/ListApplications.ts.html |here} to see how to use ListApplications API.
|
|
206
224
|
*/
|
|
207
225
|
listApplications(listApplicationsRequest: requests.ListApplicationsRequest): Promise<responses.ListApplicationsResponse>;
|
|
208
226
|
/**
|
|
227
|
+
* NOTE: This function is deprecated in favor of listApplicationsRecordIterator function.
|
|
209
228
|
* Creates a new async iterator which will iterate over the models.ApplicationSummary objects
|
|
210
229
|
* contained in responses from the listApplications operation. This iterator will fetch more data from the
|
|
211
230
|
* server as needed.
|
|
@@ -214,31 +233,50 @@ export declare class DataFlowClient {
|
|
|
214
233
|
*/
|
|
215
234
|
listAllApplications(request: requests.ListApplicationsRequest): AsyncIterableIterator<model.ApplicationSummary>;
|
|
216
235
|
/**
|
|
236
|
+
* NOTE: This function is deprecated in favor of listApplicationsResponseIterator function.
|
|
217
237
|
* Creates a new async iterator which will iterate over the responses received from the listApplications operation. This iterator
|
|
218
238
|
* will fetch more data from the server as needed.
|
|
219
239
|
*
|
|
220
240
|
* @param request a request which can be sent to the service operation
|
|
221
241
|
*/
|
|
222
242
|
listAllApplicationsResponses(request: requests.ListApplicationsRequest): AsyncIterableIterator<responses.ListApplicationsResponse>;
|
|
243
|
+
/**
|
|
244
|
+
* Creates a new async iterator which will iterate over the models.ApplicationSummary objects
|
|
245
|
+
* contained in responses from the listApplications operation. This iterator will fetch more data from the
|
|
246
|
+
* server as needed.
|
|
247
|
+
*
|
|
248
|
+
* @param request a request which can be sent to the service operation
|
|
249
|
+
*/
|
|
250
|
+
listApplicationsRecordIterator(request: requests.ListApplicationsRequest): AsyncIterableIterator<model.ApplicationSummary>;
|
|
251
|
+
/**
|
|
252
|
+
* Creates a new async iterator which will iterate over the responses received from the listApplications operation. This iterator
|
|
253
|
+
* will fetch more data from the server as needed.
|
|
254
|
+
*
|
|
255
|
+
* @param request a request which can be sent to the service operation
|
|
256
|
+
*/
|
|
257
|
+
listApplicationsResponseIterator(request: requests.ListApplicationsRequest): AsyncIterableIterator<responses.ListApplicationsResponse>;
|
|
223
258
|
/**
|
|
224
259
|
* Lists all private endpoints in the specified compartment.
|
|
225
260
|
*
|
|
261
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
226
262
|
* @param ListPrivateEndpointsRequest
|
|
227
263
|
* @return ListPrivateEndpointsResponse
|
|
228
264
|
* @throws OciError when an error occurs
|
|
229
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
265
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/ListPrivateEndpoints.ts.html |here} to see how to use ListPrivateEndpoints API.
|
|
230
266
|
*/
|
|
231
267
|
listPrivateEndpoints(listPrivateEndpointsRequest: requests.ListPrivateEndpointsRequest): Promise<responses.ListPrivateEndpointsResponse>;
|
|
232
268
|
/**
|
|
233
269
|
* Retrieves summaries of the run's logs.
|
|
234
270
|
*
|
|
271
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
235
272
|
* @param ListRunLogsRequest
|
|
236
273
|
* @return ListRunLogsResponse
|
|
237
274
|
* @throws OciError when an error occurs
|
|
238
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
275
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/ListRunLogs.ts.html |here} to see how to use ListRunLogs API.
|
|
239
276
|
*/
|
|
240
277
|
listRunLogs(listRunLogsRequest: requests.ListRunLogsRequest): Promise<responses.ListRunLogsResponse>;
|
|
241
278
|
/**
|
|
279
|
+
* NOTE: This function is deprecated in favor of listRunLogsRecordIterator function.
|
|
242
280
|
* Creates a new async iterator which will iterate over the models.RunLogSummary objects
|
|
243
281
|
* contained in responses from the listRunLogs operation. This iterator will fetch more data from the
|
|
244
282
|
* server as needed.
|
|
@@ -247,22 +285,40 @@ export declare class DataFlowClient {
|
|
|
247
285
|
*/
|
|
248
286
|
listAllRunLogs(request: requests.ListRunLogsRequest): AsyncIterableIterator<model.RunLogSummary>;
|
|
249
287
|
/**
|
|
288
|
+
* NOTE: This function is deprecated in favor of listRunLogsResponseIterator function.
|
|
250
289
|
* Creates a new async iterator which will iterate over the responses received from the listRunLogs operation. This iterator
|
|
251
290
|
* will fetch more data from the server as needed.
|
|
252
291
|
*
|
|
253
292
|
* @param request a request which can be sent to the service operation
|
|
254
293
|
*/
|
|
255
294
|
listAllRunLogsResponses(request: requests.ListRunLogsRequest): AsyncIterableIterator<responses.ListRunLogsResponse>;
|
|
295
|
+
/**
|
|
296
|
+
* Creates a new async iterator which will iterate over the models.RunLogSummary objects
|
|
297
|
+
* contained in responses from the listRunLogs operation. This iterator will fetch more data from the
|
|
298
|
+
* server as needed.
|
|
299
|
+
*
|
|
300
|
+
* @param request a request which can be sent to the service operation
|
|
301
|
+
*/
|
|
302
|
+
listRunLogsRecordIterator(request: requests.ListRunLogsRequest): AsyncIterableIterator<model.RunLogSummary>;
|
|
303
|
+
/**
|
|
304
|
+
* Creates a new async iterator which will iterate over the responses received from the listRunLogs operation. This iterator
|
|
305
|
+
* will fetch more data from the server as needed.
|
|
306
|
+
*
|
|
307
|
+
* @param request a request which can be sent to the service operation
|
|
308
|
+
*/
|
|
309
|
+
listRunLogsResponseIterator(request: requests.ListRunLogsRequest): AsyncIterableIterator<responses.ListRunLogsResponse>;
|
|
256
310
|
/**
|
|
257
311
|
* Lists all runs of an application in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.
|
|
258
312
|
*
|
|
313
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
259
314
|
* @param ListRunsRequest
|
|
260
315
|
* @return ListRunsResponse
|
|
261
316
|
* @throws OciError when an error occurs
|
|
262
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
317
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/ListRuns.ts.html |here} to see how to use ListRuns API.
|
|
263
318
|
*/
|
|
264
319
|
listRuns(listRunsRequest: requests.ListRunsRequest): Promise<responses.ListRunsResponse>;
|
|
265
320
|
/**
|
|
321
|
+
* NOTE: This function is deprecated in favor of listRunsRecordIterator function.
|
|
266
322
|
* Creates a new async iterator which will iterate over the models.RunSummary objects
|
|
267
323
|
* contained in responses from the listRuns operation. This iterator will fetch more data from the
|
|
268
324
|
* server as needed.
|
|
@@ -271,46 +327,66 @@ export declare class DataFlowClient {
|
|
|
271
327
|
*/
|
|
272
328
|
listAllRuns(request: requests.ListRunsRequest): AsyncIterableIterator<model.RunSummary>;
|
|
273
329
|
/**
|
|
330
|
+
* NOTE: This function is deprecated in favor of listRunsResponseIterator function.
|
|
274
331
|
* Creates a new async iterator which will iterate over the responses received from the listRuns operation. This iterator
|
|
275
332
|
* will fetch more data from the server as needed.
|
|
276
333
|
*
|
|
277
334
|
* @param request a request which can be sent to the service operation
|
|
278
335
|
*/
|
|
279
336
|
listAllRunsResponses(request: requests.ListRunsRequest): AsyncIterableIterator<responses.ListRunsResponse>;
|
|
337
|
+
/**
|
|
338
|
+
* Creates a new async iterator which will iterate over the models.RunSummary objects
|
|
339
|
+
* contained in responses from the listRuns operation. This iterator will fetch more data from the
|
|
340
|
+
* server as needed.
|
|
341
|
+
*
|
|
342
|
+
* @param request a request which can be sent to the service operation
|
|
343
|
+
*/
|
|
344
|
+
listRunsRecordIterator(request: requests.ListRunsRequest): AsyncIterableIterator<model.RunSummary>;
|
|
345
|
+
/**
|
|
346
|
+
* Creates a new async iterator which will iterate over the responses received from the listRuns operation. This iterator
|
|
347
|
+
* will fetch more data from the server as needed.
|
|
348
|
+
*
|
|
349
|
+
* @param request a request which can be sent to the service operation
|
|
350
|
+
*/
|
|
351
|
+
listRunsResponseIterator(request: requests.ListRunsRequest): AsyncIterableIterator<responses.ListRunsResponse>;
|
|
280
352
|
/**
|
|
281
353
|
* Return a (paginated) list of errors for a given work request.
|
|
282
354
|
*
|
|
355
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
283
356
|
* @param ListWorkRequestErrorsRequest
|
|
284
357
|
* @return ListWorkRequestErrorsResponse
|
|
285
358
|
* @throws OciError when an error occurs
|
|
286
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
359
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
|
|
287
360
|
*/
|
|
288
361
|
listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
|
|
289
362
|
/**
|
|
290
363
|
* Return a paginated list of logs for a given work request.
|
|
291
364
|
*
|
|
365
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
292
366
|
* @param ListWorkRequestLogsRequest
|
|
293
367
|
* @return ListWorkRequestLogsResponse
|
|
294
368
|
* @throws OciError when an error occurs
|
|
295
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
369
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
|
|
296
370
|
*/
|
|
297
371
|
listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
|
|
298
372
|
/**
|
|
299
373
|
* Lists the work requests in a compartment.
|
|
300
374
|
*
|
|
375
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
301
376
|
* @param ListWorkRequestsRequest
|
|
302
377
|
* @return ListWorkRequestsResponse
|
|
303
378
|
* @throws OciError when an error occurs
|
|
304
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
379
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
|
|
305
380
|
*/
|
|
306
381
|
listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
|
|
307
382
|
/**
|
|
308
383
|
* Updates an application using an `applicationId`.
|
|
309
384
|
*
|
|
385
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
310
386
|
* @param UpdateApplicationRequest
|
|
311
387
|
* @return UpdateApplicationResponse
|
|
312
388
|
* @throws OciError when an error occurs
|
|
313
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
389
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/UpdateApplication.ts.html |here} to see how to use UpdateApplication API.
|
|
314
390
|
*/
|
|
315
391
|
updateApplication(updateApplicationRequest: requests.UpdateApplicationRequest): Promise<responses.UpdateApplicationResponse>;
|
|
316
392
|
/**
|
|
@@ -318,19 +394,21 @@ export declare class DataFlowClient {
|
|
|
318
394
|
* a previously defined private endpoint, then a 409 status code will be returned. This indicates
|
|
319
395
|
* that a conflict has been detected.
|
|
320
396
|
*
|
|
397
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
321
398
|
* @param UpdatePrivateEndpointRequest
|
|
322
399
|
* @return UpdatePrivateEndpointResponse
|
|
323
400
|
* @throws OciError when an error occurs
|
|
324
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
401
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/UpdatePrivateEndpoint.ts.html |here} to see how to use UpdatePrivateEndpoint API.
|
|
325
402
|
*/
|
|
326
403
|
updatePrivateEndpoint(updatePrivateEndpointRequest: requests.UpdatePrivateEndpointRequest): Promise<responses.UpdatePrivateEndpointResponse>;
|
|
327
404
|
/**
|
|
328
405
|
* Updates a run using a `runId`.
|
|
329
406
|
*
|
|
407
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
330
408
|
* @param UpdateRunRequest
|
|
331
409
|
* @return UpdateRunResponse
|
|
332
410
|
* @throws OciError when an error occurs
|
|
333
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
411
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/dataflow/UpdateRun.ts.html |here} to see how to use UpdateRun API.
|
|
334
412
|
*/
|
|
335
413
|
updateRun(updateRunRequest: requests.UpdateRunRequest): Promise<responses.UpdateRunResponse>;
|
|
336
414
|
}
|