@globus/sdk 6.0.0-rc.1 → 6.0.0-rc.2
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/dist/esm/open-api/types/compute.d.ts +3759 -0
- package/dist/esm/open-api/types/compute.d.ts.map +1 -0
- package/dist/esm/open-api/types/compute.js +2 -0
- package/dist/esm/open-api/types/compute.js.map +1 -0
- package/dist/esm/open-api/types/gcs/v5.4.d.ts +12052 -0
- package/dist/esm/open-api/types/gcs/v5.4.d.ts.map +1 -0
- package/dist/esm/open-api/types/gcs/v5.4.js +2 -0
- package/dist/esm/open-api/types/gcs/v5.4.js.map +1 -0
- package/dist/esm/open-api/types/groups.d.ts +2382 -0
- package/dist/esm/open-api/types/groups.d.ts.map +1 -0
- package/dist/esm/open-api/types/groups.js +2 -0
- package/dist/esm/open-api/types/groups.js.map +1 -0
- package/dist/esm/open-api/types/search.d.ts +2191 -0
- package/dist/esm/open-api/types/search.d.ts.map +1 -0
- package/dist/esm/open-api/types/search.js +2 -0
- package/dist/esm/open-api/types/search.js.map +1 -0
- package/dist/esm/open-api/types/timer.d.ts +942 -0
- package/dist/esm/open-api/types/timer.d.ts.map +1 -0
- package/dist/esm/open-api/types/timer.js +2 -0
- package/dist/esm/open-api/types/timer.js.map +1 -0
- package/package.json +1 -1
- package/dist/esm/core/authorization/PopupTransport.d.ts +0 -25
- package/dist/esm/core/authorization/PopupTransport.d.ts.map +0 -1
- package/dist/esm/core/authorization/PopupTransport.js +0 -161
- package/dist/esm/core/authorization/PopupTransport.js.map +0 -1
|
@@ -0,0 +1,3759 @@
|
|
|
1
|
+
export interface paths {
|
|
2
|
+
"/v2/version": {
|
|
3
|
+
parameters: {
|
|
4
|
+
query?: never;
|
|
5
|
+
header?: never;
|
|
6
|
+
path?: never;
|
|
7
|
+
cookie?: never;
|
|
8
|
+
};
|
|
9
|
+
/**
|
|
10
|
+
* Get Version
|
|
11
|
+
* @description Get the version of the API and other services.
|
|
12
|
+
*/
|
|
13
|
+
get: operations["get_version_v2_version_get"];
|
|
14
|
+
put?: never;
|
|
15
|
+
post?: never;
|
|
16
|
+
delete?: never;
|
|
17
|
+
options?: never;
|
|
18
|
+
/**
|
|
19
|
+
* Get Version
|
|
20
|
+
* @description Get the version of the API and other services.
|
|
21
|
+
*/
|
|
22
|
+
head: operations["get_version_v2_version_head"];
|
|
23
|
+
patch?: never;
|
|
24
|
+
trace?: never;
|
|
25
|
+
};
|
|
26
|
+
"/v2/authenticate": {
|
|
27
|
+
parameters: {
|
|
28
|
+
query?: never;
|
|
29
|
+
header?: never;
|
|
30
|
+
path?: never;
|
|
31
|
+
cookie?: never;
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* Check Authentication
|
|
35
|
+
* @description Check if the user is authenticated.
|
|
36
|
+
*/
|
|
37
|
+
get: operations["check_authentication_v2_authenticate_get"];
|
|
38
|
+
put?: never;
|
|
39
|
+
post?: never;
|
|
40
|
+
delete?: never;
|
|
41
|
+
options?: never;
|
|
42
|
+
head?: never;
|
|
43
|
+
patch?: never;
|
|
44
|
+
trace?: never;
|
|
45
|
+
};
|
|
46
|
+
"/v2/stats": {
|
|
47
|
+
parameters: {
|
|
48
|
+
query?: never;
|
|
49
|
+
header?: never;
|
|
50
|
+
path?: never;
|
|
51
|
+
cookie?: never;
|
|
52
|
+
};
|
|
53
|
+
/**
|
|
54
|
+
* Get Funcx Stats
|
|
55
|
+
* @description Get various usage stats.
|
|
56
|
+
*/
|
|
57
|
+
get: operations["get_funcx_stats_v2_stats_get"];
|
|
58
|
+
put?: never;
|
|
59
|
+
post?: never;
|
|
60
|
+
delete?: never;
|
|
61
|
+
options?: never;
|
|
62
|
+
head?: never;
|
|
63
|
+
patch?: never;
|
|
64
|
+
trace?: never;
|
|
65
|
+
};
|
|
66
|
+
"/v2/get_amqp_result_connection_url": {
|
|
67
|
+
parameters: {
|
|
68
|
+
query?: never;
|
|
69
|
+
header?: never;
|
|
70
|
+
path?: never;
|
|
71
|
+
cookie?: never;
|
|
72
|
+
};
|
|
73
|
+
/**
|
|
74
|
+
* Get User Specific Result Amqp Url
|
|
75
|
+
* @description Generate new credentials (in the form of a connection URL) for connecting to
|
|
76
|
+
* the AMQP service. A new password is generated afresh every invocation, but
|
|
77
|
+
* the existing RMQ user, if any, is not deleted -- any existing connections will
|
|
78
|
+
* not be dropped. The RMQ user will have the vhost permissions set to only be
|
|
79
|
+
* allowed to read from queues with names prefixed by the ``user_uuid``.
|
|
80
|
+
*/
|
|
81
|
+
get: operations["get_user_specific_result_amqp_url_v2_get_amqp_result_connection_url_get"];
|
|
82
|
+
put?: never;
|
|
83
|
+
post?: never;
|
|
84
|
+
delete?: never;
|
|
85
|
+
options?: never;
|
|
86
|
+
head?: never;
|
|
87
|
+
patch?: never;
|
|
88
|
+
trace?: never;
|
|
89
|
+
};
|
|
90
|
+
"/v2/batch_status": {
|
|
91
|
+
parameters: {
|
|
92
|
+
query?: never;
|
|
93
|
+
header?: never;
|
|
94
|
+
path?: never;
|
|
95
|
+
cookie?: never;
|
|
96
|
+
};
|
|
97
|
+
get?: never;
|
|
98
|
+
put?: never;
|
|
99
|
+
/**
|
|
100
|
+
* Get Batch Status
|
|
101
|
+
* @description Get the status of one or more tasks.
|
|
102
|
+
*
|
|
103
|
+
* The body of a request contains a list one or more task IDs; the response
|
|
104
|
+
* will contain a dictionary of objects with a set of relevant data for
|
|
105
|
+
* each passed ID.
|
|
106
|
+
*/
|
|
107
|
+
post: operations["get_batch_status_v2_batch_status_post"];
|
|
108
|
+
delete?: never;
|
|
109
|
+
options?: never;
|
|
110
|
+
head?: never;
|
|
111
|
+
patch?: never;
|
|
112
|
+
trace?: never;
|
|
113
|
+
};
|
|
114
|
+
"/v2/submit": {
|
|
115
|
+
parameters: {
|
|
116
|
+
query?: never;
|
|
117
|
+
header?: never;
|
|
118
|
+
path?: never;
|
|
119
|
+
cookie?: never;
|
|
120
|
+
};
|
|
121
|
+
get?: never;
|
|
122
|
+
put?: never;
|
|
123
|
+
/**
|
|
124
|
+
* Submit Batch
|
|
125
|
+
* @description Entry point for submitting tasks to Globus Compute Endpoints
|
|
126
|
+
*
|
|
127
|
+
* This route takes a list of tasks (specified as a tuple of a function id, an
|
|
128
|
+
* endpoint id, and a serialized string of arguments to that function); for each
|
|
129
|
+
* task, it will generate an AMQP packet with the task information, and route it
|
|
130
|
+
* to the endpoint-appropriate AMQP queue. This route will then return a list
|
|
131
|
+
* of task ids that may be utilized to track each task's progress.
|
|
132
|
+
*
|
|
133
|
+
* Crucially, the order of the task id list returned corresponds to the order of
|
|
134
|
+
* the tasks submitted to this route. In pseudo-code,
|
|
135
|
+
* `ids[0]` ⇒ `tasks[0]`, `ids[1]` ⇒ `tasks[1]`, ...,
|
|
136
|
+
* `ids[N]` ⇒ `tasks[N]`.
|
|
137
|
+
*/
|
|
138
|
+
post: operations["submit_batch_v2_submit_post"];
|
|
139
|
+
delete?: never;
|
|
140
|
+
options?: never;
|
|
141
|
+
head?: never;
|
|
142
|
+
patch?: never;
|
|
143
|
+
trace?: never;
|
|
144
|
+
};
|
|
145
|
+
"/v2/containers": {
|
|
146
|
+
parameters: {
|
|
147
|
+
query?: never;
|
|
148
|
+
header?: never;
|
|
149
|
+
path?: never;
|
|
150
|
+
cookie?: never;
|
|
151
|
+
};
|
|
152
|
+
get?: never;
|
|
153
|
+
put?: never;
|
|
154
|
+
/**
|
|
155
|
+
* Register Container
|
|
156
|
+
* @description Register a new container
|
|
157
|
+
*/
|
|
158
|
+
post: operations["register_container_v2_containers_post"];
|
|
159
|
+
delete?: never;
|
|
160
|
+
options?: never;
|
|
161
|
+
head?: never;
|
|
162
|
+
patch?: never;
|
|
163
|
+
trace?: never;
|
|
164
|
+
};
|
|
165
|
+
"/v2/containers/build": {
|
|
166
|
+
parameters: {
|
|
167
|
+
query?: never;
|
|
168
|
+
header?: never;
|
|
169
|
+
path?: never;
|
|
170
|
+
cookie?: never;
|
|
171
|
+
};
|
|
172
|
+
get?: never;
|
|
173
|
+
put?: never;
|
|
174
|
+
/**
|
|
175
|
+
* Build Container
|
|
176
|
+
* @description Build a new container
|
|
177
|
+
*/
|
|
178
|
+
post: operations["build_container_v2_containers_build_post"];
|
|
179
|
+
delete?: never;
|
|
180
|
+
options?: never;
|
|
181
|
+
head?: never;
|
|
182
|
+
patch?: never;
|
|
183
|
+
trace?: never;
|
|
184
|
+
};
|
|
185
|
+
"/v2/containers/build/{container_uuid}": {
|
|
186
|
+
parameters: {
|
|
187
|
+
query?: never;
|
|
188
|
+
header?: never;
|
|
189
|
+
path?: never;
|
|
190
|
+
cookie?: never;
|
|
191
|
+
};
|
|
192
|
+
/**
|
|
193
|
+
* Get Container Build Status
|
|
194
|
+
* @description Get the status of a container build
|
|
195
|
+
*/
|
|
196
|
+
get: operations["get_container_build_status_v2_containers_build__container_uuid__get"];
|
|
197
|
+
put?: never;
|
|
198
|
+
post?: never;
|
|
199
|
+
delete?: never;
|
|
200
|
+
options?: never;
|
|
201
|
+
head?: never;
|
|
202
|
+
patch?: never;
|
|
203
|
+
trace?: never;
|
|
204
|
+
};
|
|
205
|
+
"/v2/containers/{container_uuid}/{container_type}": {
|
|
206
|
+
parameters: {
|
|
207
|
+
query?: never;
|
|
208
|
+
header?: never;
|
|
209
|
+
path?: never;
|
|
210
|
+
cookie?: never;
|
|
211
|
+
};
|
|
212
|
+
/**
|
|
213
|
+
* Get Container Status
|
|
214
|
+
* @description Get the details of a container
|
|
215
|
+
*/
|
|
216
|
+
get: operations["get_container_status_v2_containers__container_uuid___container_type__get"];
|
|
217
|
+
put?: never;
|
|
218
|
+
post?: never;
|
|
219
|
+
delete?: never;
|
|
220
|
+
options?: never;
|
|
221
|
+
head?: never;
|
|
222
|
+
patch?: never;
|
|
223
|
+
trace?: never;
|
|
224
|
+
};
|
|
225
|
+
"/v2/endpoints": {
|
|
226
|
+
parameters: {
|
|
227
|
+
query?: never;
|
|
228
|
+
header?: never;
|
|
229
|
+
path?: never;
|
|
230
|
+
cookie?: never;
|
|
231
|
+
};
|
|
232
|
+
/**
|
|
233
|
+
* Get Endpoints
|
|
234
|
+
* @description Get a list of endpoints associated with the authenticated user.
|
|
235
|
+
*/
|
|
236
|
+
get: operations["get_endpoints_v2_endpoints_get"];
|
|
237
|
+
put?: never;
|
|
238
|
+
/**
|
|
239
|
+
* Register Endpoint
|
|
240
|
+
* @description Register an endpoint by associating it with the authenticated user and
|
|
241
|
+
* saving it to the database.
|
|
242
|
+
*/
|
|
243
|
+
post: operations["register_endpoint_v2_endpoints_post"];
|
|
244
|
+
delete?: never;
|
|
245
|
+
options?: never;
|
|
246
|
+
head?: never;
|
|
247
|
+
patch?: never;
|
|
248
|
+
trace?: never;
|
|
249
|
+
};
|
|
250
|
+
"/v2/endpoints/{endpoint_uuid}": {
|
|
251
|
+
parameters: {
|
|
252
|
+
query?: never;
|
|
253
|
+
header?: never;
|
|
254
|
+
path?: never;
|
|
255
|
+
cookie?: never;
|
|
256
|
+
};
|
|
257
|
+
/**
|
|
258
|
+
* Get Endpoint
|
|
259
|
+
* @description Retrieve the metadata for a given endpoint.
|
|
260
|
+
*/
|
|
261
|
+
get: operations["get_endpoint_v2_endpoints__endpoint_uuid__get"];
|
|
262
|
+
put?: never;
|
|
263
|
+
post?: never;
|
|
264
|
+
/**
|
|
265
|
+
* Delete Endpoint
|
|
266
|
+
* @description Delete the endpoint.
|
|
267
|
+
*/
|
|
268
|
+
delete: operations["delete_endpoint_v2_endpoints__endpoint_uuid__delete"];
|
|
269
|
+
options?: never;
|
|
270
|
+
head?: never;
|
|
271
|
+
patch?: never;
|
|
272
|
+
trace?: never;
|
|
273
|
+
};
|
|
274
|
+
"/v2/endpoints/{endpoint_uuid}/status": {
|
|
275
|
+
parameters: {
|
|
276
|
+
query?: never;
|
|
277
|
+
header?: never;
|
|
278
|
+
path?: never;
|
|
279
|
+
cookie?: never;
|
|
280
|
+
};
|
|
281
|
+
/**
|
|
282
|
+
* Get Endpoint Status
|
|
283
|
+
* @description Get the status of an endpoint.
|
|
284
|
+
*/
|
|
285
|
+
get: operations["get_endpoint_status_v2_endpoints__endpoint_uuid__status_get"];
|
|
286
|
+
put?: never;
|
|
287
|
+
post?: never;
|
|
288
|
+
delete?: never;
|
|
289
|
+
options?: never;
|
|
290
|
+
head?: never;
|
|
291
|
+
patch?: never;
|
|
292
|
+
trace?: never;
|
|
293
|
+
};
|
|
294
|
+
"/v2/endpoints/{endpoint_uuid}/lock": {
|
|
295
|
+
parameters: {
|
|
296
|
+
query?: never;
|
|
297
|
+
header?: never;
|
|
298
|
+
path?: never;
|
|
299
|
+
cookie?: never;
|
|
300
|
+
};
|
|
301
|
+
get?: never;
|
|
302
|
+
put?: never;
|
|
303
|
+
/**
|
|
304
|
+
* Lock Endpoint
|
|
305
|
+
* @description Add a temporary lock to the endpoint to block registration requests
|
|
306
|
+
* and deletes the current RabbitMQ user/session such that existing
|
|
307
|
+
* endpoints, local or remote, shuts down upon losing credentials
|
|
308
|
+
*
|
|
309
|
+
* The POST body is ignored, as the URL and token contain the necessary info.
|
|
310
|
+
*/
|
|
311
|
+
post: operations["lock_endpoint_v2_endpoints__endpoint_uuid__lock_post"];
|
|
312
|
+
delete?: never;
|
|
313
|
+
options?: never;
|
|
314
|
+
head?: never;
|
|
315
|
+
patch?: never;
|
|
316
|
+
trace?: never;
|
|
317
|
+
};
|
|
318
|
+
"/v2/functions/{function_uuid}": {
|
|
319
|
+
parameters: {
|
|
320
|
+
query?: never;
|
|
321
|
+
header?: never;
|
|
322
|
+
path?: never;
|
|
323
|
+
cookie?: never;
|
|
324
|
+
};
|
|
325
|
+
/**
|
|
326
|
+
* Get Function
|
|
327
|
+
* @description Get information about a registered function by providing its UUID.
|
|
328
|
+
*/
|
|
329
|
+
get: operations["get_function_v2_functions__function_uuid__get"];
|
|
330
|
+
put?: never;
|
|
331
|
+
post?: never;
|
|
332
|
+
/**
|
|
333
|
+
* Delete Function
|
|
334
|
+
* @description Delete a function.
|
|
335
|
+
*/
|
|
336
|
+
delete: operations["delete_function_v2_functions__function_uuid__delete"];
|
|
337
|
+
options?: never;
|
|
338
|
+
head?: never;
|
|
339
|
+
patch?: never;
|
|
340
|
+
trace?: never;
|
|
341
|
+
};
|
|
342
|
+
"/v2/functions": {
|
|
343
|
+
parameters: {
|
|
344
|
+
query?: never;
|
|
345
|
+
header?: never;
|
|
346
|
+
path?: never;
|
|
347
|
+
cookie?: never;
|
|
348
|
+
};
|
|
349
|
+
get?: never;
|
|
350
|
+
put?: never;
|
|
351
|
+
/**
|
|
352
|
+
* Register Function
|
|
353
|
+
* @description Register a function.
|
|
354
|
+
*/
|
|
355
|
+
post: operations["register_function_v2_functions_post"];
|
|
356
|
+
delete?: never;
|
|
357
|
+
options?: never;
|
|
358
|
+
head?: never;
|
|
359
|
+
patch?: never;
|
|
360
|
+
trace?: never;
|
|
361
|
+
};
|
|
362
|
+
"/v2/tasks/{task_uuid}": {
|
|
363
|
+
parameters: {
|
|
364
|
+
query?: never;
|
|
365
|
+
header?: never;
|
|
366
|
+
path?: never;
|
|
367
|
+
cookie?: never;
|
|
368
|
+
};
|
|
369
|
+
/**
|
|
370
|
+
* Get Task Status And Result
|
|
371
|
+
* @description Check the status of a task.
|
|
372
|
+
*/
|
|
373
|
+
get: operations["get_task_status_and_result_v2_tasks__task_uuid__get"];
|
|
374
|
+
put?: never;
|
|
375
|
+
post?: never;
|
|
376
|
+
delete?: never;
|
|
377
|
+
options?: never;
|
|
378
|
+
head?: never;
|
|
379
|
+
patch?: never;
|
|
380
|
+
trace?: never;
|
|
381
|
+
};
|
|
382
|
+
"/v2/taskgroup/{task_group_uuid}": {
|
|
383
|
+
parameters: {
|
|
384
|
+
query?: never;
|
|
385
|
+
header?: never;
|
|
386
|
+
path?: never;
|
|
387
|
+
cookie?: never;
|
|
388
|
+
};
|
|
389
|
+
/**
|
|
390
|
+
* Get Task Group Tasks
|
|
391
|
+
* @description Retrieve all task UUIDs associated with a Task Group
|
|
392
|
+
*/
|
|
393
|
+
get: operations["get_task_group_tasks_v2_taskgroup__task_group_uuid__get"];
|
|
394
|
+
put?: never;
|
|
395
|
+
post?: never;
|
|
396
|
+
delete?: never;
|
|
397
|
+
options?: never;
|
|
398
|
+
head?: never;
|
|
399
|
+
patch?: never;
|
|
400
|
+
trace?: never;
|
|
401
|
+
};
|
|
402
|
+
"/v3/endpoints": {
|
|
403
|
+
parameters: {
|
|
404
|
+
query?: never;
|
|
405
|
+
header?: never;
|
|
406
|
+
path?: never;
|
|
407
|
+
cookie?: never;
|
|
408
|
+
};
|
|
409
|
+
get?: never;
|
|
410
|
+
put?: never;
|
|
411
|
+
/**
|
|
412
|
+
* Register Endpoint
|
|
413
|
+
* @description Register a new endpoint
|
|
414
|
+
*/
|
|
415
|
+
post: operations["register_endpoint_v3_endpoints_post"];
|
|
416
|
+
delete?: never;
|
|
417
|
+
options?: never;
|
|
418
|
+
head?: never;
|
|
419
|
+
patch?: never;
|
|
420
|
+
trace?: never;
|
|
421
|
+
};
|
|
422
|
+
"/v3/endpoints/{endpoint_uuid}": {
|
|
423
|
+
parameters: {
|
|
424
|
+
query?: never;
|
|
425
|
+
header?: never;
|
|
426
|
+
path?: never;
|
|
427
|
+
cookie?: never;
|
|
428
|
+
};
|
|
429
|
+
get?: never;
|
|
430
|
+
/**
|
|
431
|
+
* Update Endpoint
|
|
432
|
+
* @description Check immutable flags against existing endpoint
|
|
433
|
+
*/
|
|
434
|
+
put: operations["update_endpoint_v3_endpoints__endpoint_uuid__put"];
|
|
435
|
+
post?: never;
|
|
436
|
+
delete?: never;
|
|
437
|
+
options?: never;
|
|
438
|
+
head?: never;
|
|
439
|
+
patch?: never;
|
|
440
|
+
trace?: never;
|
|
441
|
+
};
|
|
442
|
+
"/v3/endpoints/{endpoint_uuid}/lock": {
|
|
443
|
+
parameters: {
|
|
444
|
+
query?: never;
|
|
445
|
+
header?: never;
|
|
446
|
+
path?: never;
|
|
447
|
+
cookie?: never;
|
|
448
|
+
};
|
|
449
|
+
get?: never;
|
|
450
|
+
put?: never;
|
|
451
|
+
/**
|
|
452
|
+
* Lock Endpoint
|
|
453
|
+
* @description Temporarily block registration requests for the endpoint.
|
|
454
|
+
*
|
|
455
|
+
* The current AMQP user is also deleted, dropping any open connection.
|
|
456
|
+
*/
|
|
457
|
+
post: operations["lock_endpoint_v3_endpoints__endpoint_uuid__lock_post"];
|
|
458
|
+
delete?: never;
|
|
459
|
+
options?: never;
|
|
460
|
+
head?: never;
|
|
461
|
+
patch?: never;
|
|
462
|
+
trace?: never;
|
|
463
|
+
};
|
|
464
|
+
"/v3/endpoints/{endpoint_uuid}/submit": {
|
|
465
|
+
parameters: {
|
|
466
|
+
query?: never;
|
|
467
|
+
header?: never;
|
|
468
|
+
path?: never;
|
|
469
|
+
cookie?: never;
|
|
470
|
+
};
|
|
471
|
+
get?: never;
|
|
472
|
+
put?: never;
|
|
473
|
+
/**
|
|
474
|
+
* Submit Batch
|
|
475
|
+
* @description Entry point for submitting tasks to a Globus Compute Endpoint
|
|
476
|
+
*
|
|
477
|
+
* This route takes a dictionary of function ids mapped to a list of serialized
|
|
478
|
+
* arguments destined for invocation at request‑specified (single) endpoint.
|
|
479
|
+
* The returned data structure is similar, containing a mapping of the requested
|
|
480
|
+
* function ids to the associated list of task ids. Of note is that the order of
|
|
481
|
+
* the returned task ids associated with each function id _is the same order_ as
|
|
482
|
+
* specified in the request.
|
|
483
|
+
*
|
|
484
|
+
* The `task_group_id` may be optionally specified if a set of tasks should be
|
|
485
|
+
* associated with a Task Group that was created in a previous interaction.
|
|
486
|
+
* However, if set and no task group already exists, the route will return an
|
|
487
|
+
* HTTP 404.
|
|
488
|
+
*/
|
|
489
|
+
post: operations["submit_batch_v3_endpoints__endpoint_uuid__submit_post"];
|
|
490
|
+
delete?: never;
|
|
491
|
+
options?: never;
|
|
492
|
+
head?: never;
|
|
493
|
+
patch?: never;
|
|
494
|
+
trace?: never;
|
|
495
|
+
};
|
|
496
|
+
"/v3/endpoints/{endpoint_uuid}/allowed_functions": {
|
|
497
|
+
parameters: {
|
|
498
|
+
query?: never;
|
|
499
|
+
header?: never;
|
|
500
|
+
path?: never;
|
|
501
|
+
cookie?: never;
|
|
502
|
+
};
|
|
503
|
+
/**
|
|
504
|
+
* Get Endpoint Allowlist
|
|
505
|
+
* @description Retrieve the UUIDs of the functions allowed to run on this endpoint
|
|
506
|
+
*/
|
|
507
|
+
get: operations["get_endpoint_allowlist_v3_endpoints__endpoint_uuid__allowed_functions_get"];
|
|
508
|
+
put?: never;
|
|
509
|
+
post?: never;
|
|
510
|
+
delete?: never;
|
|
511
|
+
options?: never;
|
|
512
|
+
head?: never;
|
|
513
|
+
patch?: never;
|
|
514
|
+
trace?: never;
|
|
515
|
+
};
|
|
516
|
+
"/v3/endpoints/{endpoint_uuid}/console": {
|
|
517
|
+
parameters: {
|
|
518
|
+
query?: never;
|
|
519
|
+
header?: never;
|
|
520
|
+
path?: never;
|
|
521
|
+
cookie?: never;
|
|
522
|
+
};
|
|
523
|
+
/**
|
|
524
|
+
* Get Endpoint Console Info
|
|
525
|
+
* @description Get operational information about a running multi-user endpoint.
|
|
526
|
+
*
|
|
527
|
+
* This route can only be accessed by the owner of the multi-user endpoint,
|
|
528
|
+
* which must have an associated Globus subscription.
|
|
529
|
+
*/
|
|
530
|
+
get: operations["get_endpoint_console_info_v3_endpoints__endpoint_uuid__console_get"];
|
|
531
|
+
put?: never;
|
|
532
|
+
post?: never;
|
|
533
|
+
delete?: never;
|
|
534
|
+
options?: never;
|
|
535
|
+
head?: never;
|
|
536
|
+
patch?: never;
|
|
537
|
+
trace?: never;
|
|
538
|
+
};
|
|
539
|
+
"/v3/functions": {
|
|
540
|
+
parameters: {
|
|
541
|
+
query?: never;
|
|
542
|
+
header?: never;
|
|
543
|
+
path?: never;
|
|
544
|
+
cookie?: never;
|
|
545
|
+
};
|
|
546
|
+
get?: never;
|
|
547
|
+
put?: never;
|
|
548
|
+
/**
|
|
549
|
+
* Register Function
|
|
550
|
+
* @description Register a function
|
|
551
|
+
*/
|
|
552
|
+
post: operations["register_function_v3_functions_post"];
|
|
553
|
+
delete?: never;
|
|
554
|
+
options?: never;
|
|
555
|
+
head?: never;
|
|
556
|
+
patch?: never;
|
|
557
|
+
trace?: never;
|
|
558
|
+
};
|
|
559
|
+
}
|
|
560
|
+
export type webhooks = Record<string, never>;
|
|
561
|
+
export interface components {
|
|
562
|
+
schemas: {
|
|
563
|
+
/**
|
|
564
|
+
* AllowedFunctionsResponse
|
|
565
|
+
* @example {
|
|
566
|
+
* "endpoint_id": "7348422a-1074-427b-a08a-0771068afccc",
|
|
567
|
+
* "restricted": true,
|
|
568
|
+
* "functions": [
|
|
569
|
+
* "063a3a9d-f40e-4b46-950a-fb24f75a345c",
|
|
570
|
+
* "e4b534c3-d9d0-47b0-8334-f52932ad3d9a",
|
|
571
|
+
* "ebe03b69-c966-42fb-ae3f-4a8c9e5b909e"
|
|
572
|
+
* ]
|
|
573
|
+
* }
|
|
574
|
+
*/
|
|
575
|
+
AllowedFunctionsResponse: {
|
|
576
|
+
/**
|
|
577
|
+
* Endpoint Id
|
|
578
|
+
* Format: uuid
|
|
579
|
+
* @description Endpoint UUID
|
|
580
|
+
*/
|
|
581
|
+
endpoint_id: string;
|
|
582
|
+
/**
|
|
583
|
+
* Restricted
|
|
584
|
+
* @description False if the endpoint allows execution of any function. True if the endpoint will only execute functions from it's allowed list; see the functions field.
|
|
585
|
+
*/
|
|
586
|
+
restricted: boolean;
|
|
587
|
+
/**
|
|
588
|
+
* Functions
|
|
589
|
+
* @description The functions this endpoint is allowed to execute
|
|
590
|
+
*/
|
|
591
|
+
functions?: string[];
|
|
592
|
+
};
|
|
593
|
+
/**
|
|
594
|
+
* BatchStatusRequest
|
|
595
|
+
* @example {
|
|
596
|
+
* "task_ids": [
|
|
597
|
+
* "7dac44aa-c480-4460-b453-a47b03b031f4",
|
|
598
|
+
* "4b35645f-0c5b-465d-aaec-fee87f74ff5b"
|
|
599
|
+
* ]
|
|
600
|
+
* }
|
|
601
|
+
*/
|
|
602
|
+
BatchStatusRequest: {
|
|
603
|
+
/**
|
|
604
|
+
* Task Ids
|
|
605
|
+
* @description Task UUIDs
|
|
606
|
+
*/
|
|
607
|
+
task_ids: string[];
|
|
608
|
+
};
|
|
609
|
+
/**
|
|
610
|
+
* BatchStatusResponse
|
|
611
|
+
* @example {
|
|
612
|
+
* "response": "batch",
|
|
613
|
+
* "results": {
|
|
614
|
+
* "7dac44aa-c480-4460-b453-a47b03b031f4": {
|
|
615
|
+
* "task_id": "7dac44aa-c480-4460-b453-a47b03b031f4",
|
|
616
|
+
* "status": "success",
|
|
617
|
+
* "result": "10000",
|
|
618
|
+
* "completion_t": "1677183605.212898"
|
|
619
|
+
* },
|
|
620
|
+
* "4b35645f-0c5b-465d-aaec-fee87f74ff5b": {
|
|
621
|
+
* "task_id": "4b35645f-0c5b-465d-aaec-fee87f74ff5b",
|
|
622
|
+
* "status": "failed",
|
|
623
|
+
* "reason": "Task failed"
|
|
624
|
+
* }
|
|
625
|
+
* }
|
|
626
|
+
* }
|
|
627
|
+
*/
|
|
628
|
+
BatchStatusResponse: {
|
|
629
|
+
/**
|
|
630
|
+
* Response
|
|
631
|
+
* @description Response
|
|
632
|
+
*/
|
|
633
|
+
response: string;
|
|
634
|
+
/**
|
|
635
|
+
* Results
|
|
636
|
+
* @description Task results
|
|
637
|
+
*/
|
|
638
|
+
results: {
|
|
639
|
+
[key: string]: components["schemas"]["BatchStatusResponseResults"];
|
|
640
|
+
};
|
|
641
|
+
};
|
|
642
|
+
/** BatchStatusResponseResults */
|
|
643
|
+
BatchStatusResponseResults: {
|
|
644
|
+
/**
|
|
645
|
+
* Task Id
|
|
646
|
+
* Format: uuid
|
|
647
|
+
* @description Task UUID
|
|
648
|
+
*/
|
|
649
|
+
task_id: string;
|
|
650
|
+
/**
|
|
651
|
+
* Status
|
|
652
|
+
* @description Task status
|
|
653
|
+
*/
|
|
654
|
+
status?: unknown;
|
|
655
|
+
/**
|
|
656
|
+
* Result
|
|
657
|
+
* @description Task result
|
|
658
|
+
*/
|
|
659
|
+
result?: string;
|
|
660
|
+
/**
|
|
661
|
+
* Completion T
|
|
662
|
+
* @description Task completion Unix time
|
|
663
|
+
*/
|
|
664
|
+
completion_t?: string;
|
|
665
|
+
/**
|
|
666
|
+
* Exception
|
|
667
|
+
* @description Exception
|
|
668
|
+
*/
|
|
669
|
+
exception?: string;
|
|
670
|
+
/**
|
|
671
|
+
* Reason
|
|
672
|
+
* @description Reason for exception
|
|
673
|
+
*/
|
|
674
|
+
reason?: string;
|
|
675
|
+
};
|
|
676
|
+
/** BatchSubmitResponseTask */
|
|
677
|
+
BatchSubmitResponseTask: {
|
|
678
|
+
/**
|
|
679
|
+
* Status
|
|
680
|
+
* @description Task status
|
|
681
|
+
*/
|
|
682
|
+
status: string;
|
|
683
|
+
/**
|
|
684
|
+
* Task Uuid
|
|
685
|
+
* Format: uuid
|
|
686
|
+
* @description Task UUID
|
|
687
|
+
*/
|
|
688
|
+
task_uuid: string;
|
|
689
|
+
/**
|
|
690
|
+
* Http Status Code
|
|
691
|
+
* @description HTTP status code
|
|
692
|
+
*/
|
|
693
|
+
http_status_code: number;
|
|
694
|
+
/**
|
|
695
|
+
* Reason
|
|
696
|
+
* @description Reason for exception
|
|
697
|
+
*/
|
|
698
|
+
reason?: string;
|
|
699
|
+
};
|
|
700
|
+
/**
|
|
701
|
+
* BuildStatus
|
|
702
|
+
* @description An enumeration.
|
|
703
|
+
* @enum {string}
|
|
704
|
+
*/
|
|
705
|
+
BuildStatus: "provided" | "submitted" | "initialized" | "queued" | "building" | "ready" | "failed";
|
|
706
|
+
/** ConsoleNodeInfo */
|
|
707
|
+
ConsoleNodeInfo: {
|
|
708
|
+
/**
|
|
709
|
+
* Total Worker Count
|
|
710
|
+
* @description Total number of provisioned workers on the node
|
|
711
|
+
*/
|
|
712
|
+
total_worker_count?: number;
|
|
713
|
+
/**
|
|
714
|
+
* Idle Duration Seconds
|
|
715
|
+
* @description Idle duration in seconds
|
|
716
|
+
*/
|
|
717
|
+
idle_duration_seconds?: number;
|
|
718
|
+
/**
|
|
719
|
+
* Python Version
|
|
720
|
+
* @description Node Python version
|
|
721
|
+
*/
|
|
722
|
+
python_version?: string;
|
|
723
|
+
/**
|
|
724
|
+
* Endpoint Version
|
|
725
|
+
* @description Version of `globus-compute-endpoint` running on the node
|
|
726
|
+
*/
|
|
727
|
+
endpoint_version?: string;
|
|
728
|
+
/**
|
|
729
|
+
* Sdk Version
|
|
730
|
+
* @description Version of `globus-compute-sdk` running on the node
|
|
731
|
+
*/
|
|
732
|
+
sdk_version?: string;
|
|
733
|
+
};
|
|
734
|
+
/**
|
|
735
|
+
* ConsoleResponse
|
|
736
|
+
* @example {
|
|
737
|
+
* "user_endpoints": [
|
|
738
|
+
* {
|
|
739
|
+
* "user_endpoint_id": "7348422a-1074-427b-a08a-0771068afccc",
|
|
740
|
+
* "active": true,
|
|
741
|
+
* "python_version": "3.12.7",
|
|
742
|
+
* "endpoint_version": "3.1.1",
|
|
743
|
+
* "posix_pid": 12345,
|
|
744
|
+
* "posix_username": "test_user",
|
|
745
|
+
* "start_time_iso": "2025-01-02T21:20:19.123456-05:00",
|
|
746
|
+
* "start_time_unix": 1735870819.123456,
|
|
747
|
+
* "last_heartbeat_unix": 1735884207.498273,
|
|
748
|
+
* "running_task_count": 3,
|
|
749
|
+
* "queued_task_count": 0,
|
|
750
|
+
* "executed_task_count": 15,
|
|
751
|
+
* "total_worker_count": 2,
|
|
752
|
+
* "idle_worker_count": 0,
|
|
753
|
+
* "total_node_count": 1,
|
|
754
|
+
* "node_info": {
|
|
755
|
+
* "some_job_id": [
|
|
756
|
+
* {
|
|
757
|
+
* "total_worker_count": 2,
|
|
758
|
+
* "idle_duration_seconds": 0,
|
|
759
|
+
* "python_version": "3.12.7",
|
|
760
|
+
* "endpoint_version": "3.1.1",
|
|
761
|
+
* "sdk_version": "3.1.1"
|
|
762
|
+
* }
|
|
763
|
+
* ]
|
|
764
|
+
* },
|
|
765
|
+
* "engine_type": "GlobusComputeEngine",
|
|
766
|
+
* "provider_type": "SlurmProvider",
|
|
767
|
+
* "account": "my-slurm-account",
|
|
768
|
+
* "queue": "caslake",
|
|
769
|
+
* "config": "engine:\n type: GlobusComputeEngine\n max_workers_per_node: 2\n provider:\n type: SlurmProvider\n account: my-slurm-account\n partition: caslake\n worker_init: 'module load Anaconda; source activate compute-env'\n nodes_per_block: 1\n max_blocks: 1\n address:\n type: address_by_interface\n ifname: bond0\n"
|
|
770
|
+
* }
|
|
771
|
+
* ]
|
|
772
|
+
* }
|
|
773
|
+
*/
|
|
774
|
+
ConsoleResponse: {
|
|
775
|
+
/**
|
|
776
|
+
* User Endpoints
|
|
777
|
+
* @description List of information about each running user endpoint process
|
|
778
|
+
*/
|
|
779
|
+
user_endpoints: components["schemas"]["ConsoleUserEndpointInfo"][];
|
|
780
|
+
};
|
|
781
|
+
/** ConsoleUserEndpointInfo */
|
|
782
|
+
ConsoleUserEndpointInfo: {
|
|
783
|
+
/**
|
|
784
|
+
* User Endpoint Id
|
|
785
|
+
* Format: uuid
|
|
786
|
+
* @description User endpoint UUID (key identifier)
|
|
787
|
+
*/
|
|
788
|
+
user_endpoint_id: string;
|
|
789
|
+
/**
|
|
790
|
+
* Active
|
|
791
|
+
* @description Whether the user endpoint is active
|
|
792
|
+
* @default true
|
|
793
|
+
*/
|
|
794
|
+
active: boolean;
|
|
795
|
+
/**
|
|
796
|
+
* Python Version
|
|
797
|
+
* @description User endpoint Python version
|
|
798
|
+
*/
|
|
799
|
+
python_version?: string;
|
|
800
|
+
/**
|
|
801
|
+
* Endpoint Version
|
|
802
|
+
* @description User endpoint version
|
|
803
|
+
*/
|
|
804
|
+
endpoint_version?: string;
|
|
805
|
+
/**
|
|
806
|
+
* Client Sdk Versions
|
|
807
|
+
* @description SDK versions used to submit tasks to the user endpoint
|
|
808
|
+
*/
|
|
809
|
+
client_sdk_versions?: string[];
|
|
810
|
+
/**
|
|
811
|
+
* Posix Pid
|
|
812
|
+
* @description User endpoint process ID
|
|
813
|
+
*/
|
|
814
|
+
posix_pid?: number;
|
|
815
|
+
/**
|
|
816
|
+
* Posix Username
|
|
817
|
+
* @description Local POSIX user running the user endpoint
|
|
818
|
+
*/
|
|
819
|
+
posix_username?: string;
|
|
820
|
+
/**
|
|
821
|
+
* Start Time Iso
|
|
822
|
+
* Format: date-time
|
|
823
|
+
* @description User endpoint start time in ISO format including timezone offset
|
|
824
|
+
*/
|
|
825
|
+
start_time_iso?: string;
|
|
826
|
+
/**
|
|
827
|
+
* Start Time Unix
|
|
828
|
+
* @description UNIX timestamp indicating when the user endpoint was started
|
|
829
|
+
*/
|
|
830
|
+
start_time_unix?: number;
|
|
831
|
+
/**
|
|
832
|
+
* Last Heartbeat Unix
|
|
833
|
+
* @description UNIX timestamp indicating when the services last processed a heartbeat for the user endpoint
|
|
834
|
+
*/
|
|
835
|
+
last_heartbeat_unix?: number;
|
|
836
|
+
/**
|
|
837
|
+
* Total Worker Count
|
|
838
|
+
* @description Total number of provisioned workers
|
|
839
|
+
*/
|
|
840
|
+
total_worker_count?: number;
|
|
841
|
+
/**
|
|
842
|
+
* Idle Worker Count
|
|
843
|
+
* @description Number of idle workers
|
|
844
|
+
*/
|
|
845
|
+
idle_worker_count?: number;
|
|
846
|
+
/**
|
|
847
|
+
* Total Node Count
|
|
848
|
+
* @description Total number of provisioned nodes
|
|
849
|
+
*/
|
|
850
|
+
total_node_count?: number;
|
|
851
|
+
/**
|
|
852
|
+
* Node Info
|
|
853
|
+
* @description Details for each provisioned node, indexed by job ID
|
|
854
|
+
*/
|
|
855
|
+
node_info?: {
|
|
856
|
+
[key: string]: components["schemas"]["ConsoleNodeInfo"][];
|
|
857
|
+
};
|
|
858
|
+
/**
|
|
859
|
+
* Running Task Count
|
|
860
|
+
* @description Number of running tasks
|
|
861
|
+
*/
|
|
862
|
+
running_task_count?: number;
|
|
863
|
+
/**
|
|
864
|
+
* Queued Task Count
|
|
865
|
+
* @description Number of queued tasks
|
|
866
|
+
*/
|
|
867
|
+
queued_task_count?: number;
|
|
868
|
+
/**
|
|
869
|
+
* Executed Task Count
|
|
870
|
+
* @description Number of executed tasks
|
|
871
|
+
*/
|
|
872
|
+
executed_task_count?: number;
|
|
873
|
+
/**
|
|
874
|
+
* Engine Type
|
|
875
|
+
* @description User endpoint engine type. See our documentation for more information: https://globus-compute.readthedocs.io/en/latest/endpoints/config_reference.html#user-endpoint-configuration
|
|
876
|
+
*/
|
|
877
|
+
engine_type?: string;
|
|
878
|
+
/**
|
|
879
|
+
* Provider Type
|
|
880
|
+
* @description User endpoint provider type. See our documentation for more information: https://globus-compute.readthedocs.io/en/latest/endpoints/config_reference.html#user-endpoint-configuration
|
|
881
|
+
*/
|
|
882
|
+
provider_type?: string;
|
|
883
|
+
/**
|
|
884
|
+
* Account
|
|
885
|
+
* @description The account against which the scheduler charges resources that are consumed by the user endpoint
|
|
886
|
+
*/
|
|
887
|
+
account?: string;
|
|
888
|
+
/**
|
|
889
|
+
* Queue
|
|
890
|
+
* @description The scheduler queue to which the user endpoint will submit jobs
|
|
891
|
+
*/
|
|
892
|
+
queue?: string;
|
|
893
|
+
/**
|
|
894
|
+
* Config
|
|
895
|
+
* @description User endpoint configuration YAML content. We do not include this field by default because it may be quite large. Users must explicitly request it using the `include_fields` query parameter.
|
|
896
|
+
*/
|
|
897
|
+
config?: string;
|
|
898
|
+
};
|
|
899
|
+
/**
|
|
900
|
+
* ContainerBuildRequest
|
|
901
|
+
* @example {
|
|
902
|
+
* "name": "My Container",
|
|
903
|
+
* "description": "Container with vim and git installed using apt and numpy and pandas installed using pip.",
|
|
904
|
+
* "apt": [
|
|
905
|
+
* "vim",
|
|
906
|
+
* "git"
|
|
907
|
+
* ],
|
|
908
|
+
* "pip": [
|
|
909
|
+
* "numpy",
|
|
910
|
+
* "pandas"
|
|
911
|
+
* ],
|
|
912
|
+
* "conda": [],
|
|
913
|
+
* "payload_url": "https://github.com/my-container"
|
|
914
|
+
* }
|
|
915
|
+
*/
|
|
916
|
+
ContainerBuildRequest: {
|
|
917
|
+
/**
|
|
918
|
+
* Name
|
|
919
|
+
* @description Container name
|
|
920
|
+
*/
|
|
921
|
+
name: string;
|
|
922
|
+
/**
|
|
923
|
+
* Description
|
|
924
|
+
* @description Long container description
|
|
925
|
+
*/
|
|
926
|
+
description?: string;
|
|
927
|
+
/**
|
|
928
|
+
* Apt
|
|
929
|
+
* @description Optional list of package names to be installed via apt-get
|
|
930
|
+
*/
|
|
931
|
+
apt: string[];
|
|
932
|
+
/**
|
|
933
|
+
* Pip
|
|
934
|
+
* @description Optional list of pip requirements (name and optional version specifier)
|
|
935
|
+
*/
|
|
936
|
+
pip: string[];
|
|
937
|
+
/**
|
|
938
|
+
* Conda
|
|
939
|
+
* @description Optional list of conda requirements (name and optional version specifier)
|
|
940
|
+
*/
|
|
941
|
+
conda: string[];
|
|
942
|
+
/**
|
|
943
|
+
* Payload Url
|
|
944
|
+
* Format: uri
|
|
945
|
+
* @description URL to GitHub repo or publicly readable zip file
|
|
946
|
+
*/
|
|
947
|
+
payload_url?: string;
|
|
948
|
+
};
|
|
949
|
+
/**
|
|
950
|
+
* ContainerBuildResponse
|
|
951
|
+
* @example {
|
|
952
|
+
* "container_id": "b7a42fa2-e97f-4061-9e64-2ede22ae7f5e"
|
|
953
|
+
* }
|
|
954
|
+
*/
|
|
955
|
+
ContainerBuildResponse: {
|
|
956
|
+
/**
|
|
957
|
+
* Container Id
|
|
958
|
+
* Format: uuid
|
|
959
|
+
* @description Container UUID
|
|
960
|
+
*/
|
|
961
|
+
container_id: string;
|
|
962
|
+
};
|
|
963
|
+
/**
|
|
964
|
+
* ContainerBuildStatusResponse
|
|
965
|
+
* @example {
|
|
966
|
+
* "status": "ready"
|
|
967
|
+
* }
|
|
968
|
+
*/
|
|
969
|
+
ContainerBuildStatusResponse: {
|
|
970
|
+
/** @description Container build status */
|
|
971
|
+
status: components["schemas"]["BuildStatus"];
|
|
972
|
+
};
|
|
973
|
+
/**
|
|
974
|
+
* ContainerRegisterRequest
|
|
975
|
+
* @example {
|
|
976
|
+
* "name": "My Container",
|
|
977
|
+
* "description": "My container description",
|
|
978
|
+
* "type": "docker",
|
|
979
|
+
* "location": "docker://my-container:latest"
|
|
980
|
+
* }
|
|
981
|
+
*/
|
|
982
|
+
ContainerRegisterRequest: {
|
|
983
|
+
/**
|
|
984
|
+
* Name
|
|
985
|
+
* @description Container name
|
|
986
|
+
*/
|
|
987
|
+
name: string;
|
|
988
|
+
/**
|
|
989
|
+
* Description
|
|
990
|
+
* @description Long container description
|
|
991
|
+
*/
|
|
992
|
+
description?: string;
|
|
993
|
+
type: components["schemas"]["ContainerRuntime"];
|
|
994
|
+
/**
|
|
995
|
+
* Location
|
|
996
|
+
* @description The location of the container (e.g., its docker url)
|
|
997
|
+
*/
|
|
998
|
+
location: string;
|
|
999
|
+
};
|
|
1000
|
+
/**
|
|
1001
|
+
* ContainerRegisterResponse
|
|
1002
|
+
* @example {
|
|
1003
|
+
* "container_id": "b7a42fa2-e97f-4061-9e64-2ede22ae7f5e"
|
|
1004
|
+
* }
|
|
1005
|
+
*/
|
|
1006
|
+
ContainerRegisterResponse: {
|
|
1007
|
+
/**
|
|
1008
|
+
* Container Id
|
|
1009
|
+
* Format: uuid
|
|
1010
|
+
* @description Container UUID
|
|
1011
|
+
*/
|
|
1012
|
+
container_id: string;
|
|
1013
|
+
};
|
|
1014
|
+
/**
|
|
1015
|
+
* ContainerRuntime
|
|
1016
|
+
* @description Runtime to be used to execute the container.
|
|
1017
|
+
* @enum {string}
|
|
1018
|
+
*/
|
|
1019
|
+
ContainerRuntime: "docker" | "singularity";
|
|
1020
|
+
/** ContainerStatus */
|
|
1021
|
+
ContainerStatus: {
|
|
1022
|
+
/**
|
|
1023
|
+
* Container Uuid
|
|
1024
|
+
* Format: uuid
|
|
1025
|
+
* @description Container UUID
|
|
1026
|
+
*/
|
|
1027
|
+
container_uuid: string;
|
|
1028
|
+
/**
|
|
1029
|
+
* Name
|
|
1030
|
+
* @description Container name
|
|
1031
|
+
*/
|
|
1032
|
+
name: string;
|
|
1033
|
+
/** @description Container build status */
|
|
1034
|
+
build_status: components["schemas"]["BuildStatus"];
|
|
1035
|
+
type?: components["schemas"]["ContainerRuntime"];
|
|
1036
|
+
/**
|
|
1037
|
+
* Location
|
|
1038
|
+
* @description Container location
|
|
1039
|
+
*/
|
|
1040
|
+
location?: string;
|
|
1041
|
+
/**
|
|
1042
|
+
* Build Stderr
|
|
1043
|
+
* @description Container build stderr
|
|
1044
|
+
*/
|
|
1045
|
+
build_stderr?: string;
|
|
1046
|
+
/**
|
|
1047
|
+
* Err Message
|
|
1048
|
+
* @description Container error message
|
|
1049
|
+
*/
|
|
1050
|
+
err_message?: string;
|
|
1051
|
+
};
|
|
1052
|
+
/**
|
|
1053
|
+
* ContainerStatusResponse
|
|
1054
|
+
* @example {
|
|
1055
|
+
* "container": {
|
|
1056
|
+
* "container_uuid": "b7a42fa2-e97f-4061-9e64-2ede22ae7f5e",
|
|
1057
|
+
* "name": "My Container",
|
|
1058
|
+
* "build_status": "ready",
|
|
1059
|
+
* "type": "docker",
|
|
1060
|
+
* "location": "docker://my-container:latest"
|
|
1061
|
+
* }
|
|
1062
|
+
* }
|
|
1063
|
+
*/
|
|
1064
|
+
ContainerStatusResponse: {
|
|
1065
|
+
container: components["schemas"]["ContainerStatus"];
|
|
1066
|
+
};
|
|
1067
|
+
/**
|
|
1068
|
+
* DeleteFunctionResponse
|
|
1069
|
+
* @example {
|
|
1070
|
+
* "result": 302
|
|
1071
|
+
* }
|
|
1072
|
+
*/
|
|
1073
|
+
DeleteFunctionResponse: {
|
|
1074
|
+
/**
|
|
1075
|
+
* Result
|
|
1076
|
+
* @description The result as a status code integer
|
|
1077
|
+
*/
|
|
1078
|
+
result: number;
|
|
1079
|
+
};
|
|
1080
|
+
/**
|
|
1081
|
+
* Endpoint
|
|
1082
|
+
* @example {
|
|
1083
|
+
* "uuid": "7348422a-1074-427b-a08a-0771068afccc",
|
|
1084
|
+
* "name": "My Endpoint",
|
|
1085
|
+
* "display_name": "My Endpoint's display name",
|
|
1086
|
+
* "multi_user": false,
|
|
1087
|
+
* "high_assurance": false,
|
|
1088
|
+
* "public": false,
|
|
1089
|
+
* "endpoint_config": "",
|
|
1090
|
+
* "user_config_template": {},
|
|
1091
|
+
* "user_config_schema": {},
|
|
1092
|
+
* "description": "My endpoint description",
|
|
1093
|
+
* "hostname": "my-endpoint",
|
|
1094
|
+
* "local_user": "user",
|
|
1095
|
+
* "ip_address": "140.221.112.13",
|
|
1096
|
+
* "endpoint_version": "1.0.10",
|
|
1097
|
+
* "sdk_version": "1.0.10",
|
|
1098
|
+
* "python_version": "3.12.7",
|
|
1099
|
+
* "subscription_uuid": "b0b7b089-707a-4d90-a036-05b7964d6b60"
|
|
1100
|
+
* }
|
|
1101
|
+
*/
|
|
1102
|
+
Endpoint: {
|
|
1103
|
+
/**
|
|
1104
|
+
* Uuid
|
|
1105
|
+
* Format: uuid
|
|
1106
|
+
* @description Endpoint UUID
|
|
1107
|
+
*/
|
|
1108
|
+
uuid: string;
|
|
1109
|
+
/**
|
|
1110
|
+
* Name
|
|
1111
|
+
* @description Endpoint name
|
|
1112
|
+
*/
|
|
1113
|
+
name: string;
|
|
1114
|
+
/**
|
|
1115
|
+
* Display Name
|
|
1116
|
+
* @description Display name
|
|
1117
|
+
*/
|
|
1118
|
+
display_name: string;
|
|
1119
|
+
/**
|
|
1120
|
+
* Multi User
|
|
1121
|
+
* @description Endpoint multi-user mode
|
|
1122
|
+
*/
|
|
1123
|
+
multi_user: boolean;
|
|
1124
|
+
/**
|
|
1125
|
+
* High Assurance
|
|
1126
|
+
* @description Endpoint supports high-assurance protocols
|
|
1127
|
+
*/
|
|
1128
|
+
high_assurance: boolean;
|
|
1129
|
+
/**
|
|
1130
|
+
* Public
|
|
1131
|
+
* @description Indicates if all users can discover the multi-user endpoint.
|
|
1132
|
+
*/
|
|
1133
|
+
public: boolean;
|
|
1134
|
+
/**
|
|
1135
|
+
* Config
|
|
1136
|
+
* @deprecated
|
|
1137
|
+
* @description This field is deprecated. Please use endpoint_config instead.
|
|
1138
|
+
*/
|
|
1139
|
+
config?: Record<string, unknown>;
|
|
1140
|
+
/**
|
|
1141
|
+
* Endpoint Config
|
|
1142
|
+
* @description The contents of the endpoint's configuration file (config.yaml).
|
|
1143
|
+
*/
|
|
1144
|
+
endpoint_config?: string;
|
|
1145
|
+
/**
|
|
1146
|
+
* User Config Template
|
|
1147
|
+
* @description Multi-user endpoints will render this Jinja template with user-provided variables to generate a user-specific endpoint configuration.
|
|
1148
|
+
*/
|
|
1149
|
+
user_config_template?: string;
|
|
1150
|
+
/**
|
|
1151
|
+
* User Config Schema
|
|
1152
|
+
* @description User endpoint configuration schema
|
|
1153
|
+
*/
|
|
1154
|
+
user_config_schema?: Record<string, unknown>;
|
|
1155
|
+
/**
|
|
1156
|
+
* Description
|
|
1157
|
+
* @description Endpoint description
|
|
1158
|
+
*/
|
|
1159
|
+
description?: string;
|
|
1160
|
+
/**
|
|
1161
|
+
* Hostname
|
|
1162
|
+
* @description Endpoint hostname
|
|
1163
|
+
*/
|
|
1164
|
+
hostname?: string;
|
|
1165
|
+
/**
|
|
1166
|
+
* Local User
|
|
1167
|
+
* @description Endpoint local user
|
|
1168
|
+
*/
|
|
1169
|
+
local_user?: string;
|
|
1170
|
+
/**
|
|
1171
|
+
* Ip Address
|
|
1172
|
+
* Format: ipvanyaddress
|
|
1173
|
+
* @description Endpoint IP address
|
|
1174
|
+
*/
|
|
1175
|
+
ip_address?: string;
|
|
1176
|
+
/**
|
|
1177
|
+
* Endpoint Version
|
|
1178
|
+
* @description Endpoint version
|
|
1179
|
+
*/
|
|
1180
|
+
endpoint_version?: string;
|
|
1181
|
+
/**
|
|
1182
|
+
* Sdk Version
|
|
1183
|
+
* @description Endpoint SDK version
|
|
1184
|
+
*/
|
|
1185
|
+
sdk_version?: string;
|
|
1186
|
+
/**
|
|
1187
|
+
* Python Version
|
|
1188
|
+
* @description Endpoint Python version
|
|
1189
|
+
*/
|
|
1190
|
+
python_version?: string;
|
|
1191
|
+
/**
|
|
1192
|
+
* Subscription Uuid
|
|
1193
|
+
* Format: uuid
|
|
1194
|
+
* @description Globus subscription UUID
|
|
1195
|
+
*/
|
|
1196
|
+
subscription_uuid?: string;
|
|
1197
|
+
};
|
|
1198
|
+
/**
|
|
1199
|
+
* EndpointConfig
|
|
1200
|
+
* @example {
|
|
1201
|
+
* "endpoint_id": "7348422a-1074-427b-a08a-0771068afccc",
|
|
1202
|
+
* "task_queue_info": {
|
|
1203
|
+
* "connection_url": "amqps://user:password@mq.fqdn",
|
|
1204
|
+
* "exchange": "some_exchange",
|
|
1205
|
+
* "queue": "some_queue"
|
|
1206
|
+
* },
|
|
1207
|
+
* "result_queue_info": {
|
|
1208
|
+
* "connection_url": "amqps://user:password@mq.fqdn",
|
|
1209
|
+
* "exchange": "some_exchange",
|
|
1210
|
+
* "queue": "some_queue",
|
|
1211
|
+
* "queue_publish_kwargs": {
|
|
1212
|
+
* "exchange": "some_exchange",
|
|
1213
|
+
* "routing_key": "some_key",
|
|
1214
|
+
* "mandatory": true,
|
|
1215
|
+
* "properties": {
|
|
1216
|
+
* "delivery_mode": 2
|
|
1217
|
+
* }
|
|
1218
|
+
* }
|
|
1219
|
+
* },
|
|
1220
|
+
* "warnings": []
|
|
1221
|
+
* }
|
|
1222
|
+
*/
|
|
1223
|
+
EndpointConfig: {
|
|
1224
|
+
/**
|
|
1225
|
+
* Endpoint Id
|
|
1226
|
+
* Format: uuid
|
|
1227
|
+
* @description Endpoint UUID
|
|
1228
|
+
*/
|
|
1229
|
+
endpoint_id: string;
|
|
1230
|
+
task_queue_info: components["schemas"]["EndpointConfigQueueInfo"];
|
|
1231
|
+
result_queue_info: components["schemas"]["EndpointConfigResultQueue"];
|
|
1232
|
+
/**
|
|
1233
|
+
* Warnings
|
|
1234
|
+
* @description Warnings
|
|
1235
|
+
*/
|
|
1236
|
+
warnings?: string[];
|
|
1237
|
+
};
|
|
1238
|
+
/** EndpointConfigQueueInfo */
|
|
1239
|
+
EndpointConfigQueueInfo: {
|
|
1240
|
+
/**
|
|
1241
|
+
* Connection Url
|
|
1242
|
+
* @description Connection URL
|
|
1243
|
+
*/
|
|
1244
|
+
connection_url: string;
|
|
1245
|
+
/**
|
|
1246
|
+
* Exchange
|
|
1247
|
+
* @description Exchange
|
|
1248
|
+
*/
|
|
1249
|
+
exchange: string;
|
|
1250
|
+
/**
|
|
1251
|
+
* Queue
|
|
1252
|
+
* @description Queue
|
|
1253
|
+
*/
|
|
1254
|
+
queue: string;
|
|
1255
|
+
};
|
|
1256
|
+
/** EndpointConfigResultQueue */
|
|
1257
|
+
EndpointConfigResultQueue: {
|
|
1258
|
+
/**
|
|
1259
|
+
* Connection Url
|
|
1260
|
+
* @description Connection URL
|
|
1261
|
+
*/
|
|
1262
|
+
connection_url: string;
|
|
1263
|
+
/**
|
|
1264
|
+
* Exchange
|
|
1265
|
+
* @description Exchange
|
|
1266
|
+
*/
|
|
1267
|
+
exchange: string;
|
|
1268
|
+
/**
|
|
1269
|
+
* Queue
|
|
1270
|
+
* @description Queue
|
|
1271
|
+
*/
|
|
1272
|
+
queue: string;
|
|
1273
|
+
queue_publish_kwargs: components["schemas"]["EndpointConfigResultQueuePublish"];
|
|
1274
|
+
};
|
|
1275
|
+
/** EndpointConfigResultQueuePublish */
|
|
1276
|
+
EndpointConfigResultQueuePublish: {
|
|
1277
|
+
/**
|
|
1278
|
+
* Exchange
|
|
1279
|
+
* @description Exchange
|
|
1280
|
+
*/
|
|
1281
|
+
exchange: string;
|
|
1282
|
+
/**
|
|
1283
|
+
* Routing Key
|
|
1284
|
+
* @description Routing key
|
|
1285
|
+
*/
|
|
1286
|
+
routing_key: string;
|
|
1287
|
+
/**
|
|
1288
|
+
* Mandatory
|
|
1289
|
+
* @description Mandatory
|
|
1290
|
+
*/
|
|
1291
|
+
mandatory: boolean;
|
|
1292
|
+
properties: components["schemas"]["EndpointConfigResultQueuePublishProperties"];
|
|
1293
|
+
};
|
|
1294
|
+
/** EndpointConfigResultQueuePublishProperties */
|
|
1295
|
+
EndpointConfigResultQueuePublishProperties: {
|
|
1296
|
+
/**
|
|
1297
|
+
* Delivery Mode
|
|
1298
|
+
* @description Delivery mode
|
|
1299
|
+
*/
|
|
1300
|
+
delivery_mode: number;
|
|
1301
|
+
};
|
|
1302
|
+
/**
|
|
1303
|
+
* EndpointDeleteResponse
|
|
1304
|
+
* @example {
|
|
1305
|
+
* "result": 302
|
|
1306
|
+
* }
|
|
1307
|
+
*/
|
|
1308
|
+
EndpointDeleteResponse: {
|
|
1309
|
+
/**
|
|
1310
|
+
* Result
|
|
1311
|
+
* @description The result as a status code integer
|
|
1312
|
+
*/
|
|
1313
|
+
result: number;
|
|
1314
|
+
};
|
|
1315
|
+
/**
|
|
1316
|
+
* EndpointListResponseEntry
|
|
1317
|
+
* @example {
|
|
1318
|
+
* "uuid": "7348422a-1074-427b-a08a-0771068afccc",
|
|
1319
|
+
* "name": "My Endpoint",
|
|
1320
|
+
* "display_name": "My Endpoint's display name",
|
|
1321
|
+
* "owner": "0b3390f4-ca5f-496d-a7b9-9e4faed46bff"
|
|
1322
|
+
* }
|
|
1323
|
+
*/
|
|
1324
|
+
EndpointListResponseEntry: {
|
|
1325
|
+
/**
|
|
1326
|
+
* Uuid
|
|
1327
|
+
* Format: uuid
|
|
1328
|
+
* @description Endpoint UUID
|
|
1329
|
+
*/
|
|
1330
|
+
uuid: string;
|
|
1331
|
+
/**
|
|
1332
|
+
* Name
|
|
1333
|
+
* @description Endpoint name
|
|
1334
|
+
*/
|
|
1335
|
+
name: string;
|
|
1336
|
+
/**
|
|
1337
|
+
* Display Name
|
|
1338
|
+
* @description Display name
|
|
1339
|
+
*/
|
|
1340
|
+
display_name: string;
|
|
1341
|
+
/**
|
|
1342
|
+
* Owner
|
|
1343
|
+
* Format: uuid
|
|
1344
|
+
* @description Endpoint owner's identity ID
|
|
1345
|
+
*/
|
|
1346
|
+
owner: string;
|
|
1347
|
+
};
|
|
1348
|
+
/** EndpointMetadata */
|
|
1349
|
+
EndpointMetadata: {
|
|
1350
|
+
/**
|
|
1351
|
+
* Config
|
|
1352
|
+
* @deprecated
|
|
1353
|
+
* @description This field is deprecated. Please use endpoint_config instead.
|
|
1354
|
+
*/
|
|
1355
|
+
config?: Record<string, unknown>;
|
|
1356
|
+
/**
|
|
1357
|
+
* Endpoint Config
|
|
1358
|
+
* @description The contents of the endpoint's configuration file (config.yaml).
|
|
1359
|
+
*/
|
|
1360
|
+
endpoint_config?: string;
|
|
1361
|
+
/**
|
|
1362
|
+
* User Config Template
|
|
1363
|
+
* @description Multi-user endpoints will render this Jinja template with user-provided variables to generate a user-specific endpoint configuration.
|
|
1364
|
+
*/
|
|
1365
|
+
user_config_template?: string;
|
|
1366
|
+
/**
|
|
1367
|
+
* User Config Schema
|
|
1368
|
+
* @description User endpoint configuration schema
|
|
1369
|
+
*/
|
|
1370
|
+
user_config_schema?: Record<string, unknown>;
|
|
1371
|
+
/**
|
|
1372
|
+
* Description
|
|
1373
|
+
* @description Endpoint description
|
|
1374
|
+
*/
|
|
1375
|
+
description?: string;
|
|
1376
|
+
/**
|
|
1377
|
+
* Ip Address
|
|
1378
|
+
* Format: ipvanyaddress
|
|
1379
|
+
* @description Endpoint IP address
|
|
1380
|
+
*/
|
|
1381
|
+
ip_address?: string;
|
|
1382
|
+
/**
|
|
1383
|
+
* Hostname
|
|
1384
|
+
* @description Endpoint hostname
|
|
1385
|
+
*/
|
|
1386
|
+
hostname?: string;
|
|
1387
|
+
/**
|
|
1388
|
+
* Local User
|
|
1389
|
+
* @description Endpoint local user
|
|
1390
|
+
*/
|
|
1391
|
+
local_user?: string;
|
|
1392
|
+
/**
|
|
1393
|
+
* Sdk Version
|
|
1394
|
+
* @description Endpoint SDK version
|
|
1395
|
+
*/
|
|
1396
|
+
sdk_version?: string;
|
|
1397
|
+
/**
|
|
1398
|
+
* Endpoint Version
|
|
1399
|
+
* @description Endpoint version
|
|
1400
|
+
*/
|
|
1401
|
+
endpoint_version?: string;
|
|
1402
|
+
/**
|
|
1403
|
+
* Python Version
|
|
1404
|
+
* @description Endpoint Python version
|
|
1405
|
+
*/
|
|
1406
|
+
python_version?: string;
|
|
1407
|
+
};
|
|
1408
|
+
/** EndpointRegisterMetadata */
|
|
1409
|
+
EndpointRegisterMetadata: {
|
|
1410
|
+
/**
|
|
1411
|
+
* Config
|
|
1412
|
+
* @deprecated
|
|
1413
|
+
* @description This field is deprecated. Please use endpoint_config instead.
|
|
1414
|
+
*/
|
|
1415
|
+
config?: Record<string, unknown>;
|
|
1416
|
+
/**
|
|
1417
|
+
* Endpoint Config
|
|
1418
|
+
* @description The contents of the endpoint's configuration file (config.yaml).
|
|
1419
|
+
*/
|
|
1420
|
+
endpoint_config?: string;
|
|
1421
|
+
/**
|
|
1422
|
+
* User Config Template
|
|
1423
|
+
* @description Multi-user endpoints will render this Jinja template with user-provided variables to generate a user-specific endpoint configuration.
|
|
1424
|
+
*/
|
|
1425
|
+
user_config_template?: string;
|
|
1426
|
+
/**
|
|
1427
|
+
* User Config Schema
|
|
1428
|
+
* @description User endpoint configuration schema
|
|
1429
|
+
*/
|
|
1430
|
+
user_config_schema?: Record<string, unknown>;
|
|
1431
|
+
/**
|
|
1432
|
+
* Description
|
|
1433
|
+
* @description Endpoint description
|
|
1434
|
+
*/
|
|
1435
|
+
description?: string;
|
|
1436
|
+
/**
|
|
1437
|
+
* Ip Address
|
|
1438
|
+
* @description Endpoint IP address
|
|
1439
|
+
*/
|
|
1440
|
+
ip_address?: string;
|
|
1441
|
+
/**
|
|
1442
|
+
* Hostname
|
|
1443
|
+
* @description Endpoint hostname
|
|
1444
|
+
*/
|
|
1445
|
+
hostname?: string;
|
|
1446
|
+
/**
|
|
1447
|
+
* Local User
|
|
1448
|
+
* @description Endpoint local user
|
|
1449
|
+
*/
|
|
1450
|
+
local_user?: string;
|
|
1451
|
+
/**
|
|
1452
|
+
* Sdk Version
|
|
1453
|
+
* @description Endpoint SDK version
|
|
1454
|
+
*/
|
|
1455
|
+
sdk_version?: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* Endpoint Version
|
|
1458
|
+
* @description Endpoint version
|
|
1459
|
+
*/
|
|
1460
|
+
endpoint_version?: string;
|
|
1461
|
+
/**
|
|
1462
|
+
* Python Version
|
|
1463
|
+
* @description Endpoint Python version
|
|
1464
|
+
*/
|
|
1465
|
+
python_version?: string;
|
|
1466
|
+
};
|
|
1467
|
+
/**
|
|
1468
|
+
* EndpointRegisterResponse
|
|
1469
|
+
* @example {
|
|
1470
|
+
* "endpoint_id": "7348422a-1074-427b-a08a-0771068afccc",
|
|
1471
|
+
* "task_queue_info": {
|
|
1472
|
+
* "connection_url": "amqps://user:password@mq.fqdn",
|
|
1473
|
+
* "exchange": "some_exchange",
|
|
1474
|
+
* "queue": "some_queue"
|
|
1475
|
+
* },
|
|
1476
|
+
* "result_queue_info": {
|
|
1477
|
+
* "connection_url": "amqps://user:password@mq.fqdn",
|
|
1478
|
+
* "exchange": "some_exchange",
|
|
1479
|
+
* "queue": "some_queue",
|
|
1480
|
+
* "queue_publish_kwargs": {
|
|
1481
|
+
* "exchange": "some_exchange",
|
|
1482
|
+
* "routing_key": "some_key",
|
|
1483
|
+
* "mandatory": true,
|
|
1484
|
+
* "properties": {
|
|
1485
|
+
* "delivery_mode": 2
|
|
1486
|
+
* }
|
|
1487
|
+
* }
|
|
1488
|
+
* },
|
|
1489
|
+
* "heartbeat_queue_info": {
|
|
1490
|
+
* "connection_url": "amqps://user:password@mq.fqdn",
|
|
1491
|
+
* "exchange": "some_exchange",
|
|
1492
|
+
* "queue": "some_queue",
|
|
1493
|
+
* "queue_publish_kwargs": {
|
|
1494
|
+
* "exchange": "some_exchange",
|
|
1495
|
+
* "routing_key": "some_key",
|
|
1496
|
+
* "mandatory": true,
|
|
1497
|
+
* "properties": {
|
|
1498
|
+
* "delivery_mode": 2
|
|
1499
|
+
* }
|
|
1500
|
+
* }
|
|
1501
|
+
* }
|
|
1502
|
+
* }
|
|
1503
|
+
*/
|
|
1504
|
+
EndpointRegisterResponse: {
|
|
1505
|
+
/**
|
|
1506
|
+
* Endpoint Id
|
|
1507
|
+
* Format: uuid
|
|
1508
|
+
* @description Endpoint UUID
|
|
1509
|
+
*/
|
|
1510
|
+
endpoint_id: string;
|
|
1511
|
+
task_queue_info: components["schemas"]["ReadQueueInfo"];
|
|
1512
|
+
result_queue_info: components["schemas"]["WriteQueueInfo"];
|
|
1513
|
+
heartbeat_queue_info: components["schemas"]["WriteQueueInfo"];
|
|
1514
|
+
/**
|
|
1515
|
+
* Warnings
|
|
1516
|
+
* @description Warnings
|
|
1517
|
+
*/
|
|
1518
|
+
warnings?: string[];
|
|
1519
|
+
};
|
|
1520
|
+
/** EndpointStatusDetails */
|
|
1521
|
+
EndpointStatusDetails: {
|
|
1522
|
+
/**
|
|
1523
|
+
* Total Workers
|
|
1524
|
+
* @description Total number of workers
|
|
1525
|
+
*/
|
|
1526
|
+
total_workers: number;
|
|
1527
|
+
/**
|
|
1528
|
+
* Idle Workers
|
|
1529
|
+
* @description Number of idle workers
|
|
1530
|
+
*/
|
|
1531
|
+
idle_workers: number;
|
|
1532
|
+
/**
|
|
1533
|
+
* Pending Tasks
|
|
1534
|
+
* @description Number of pending tasks
|
|
1535
|
+
*/
|
|
1536
|
+
pending_tasks: number;
|
|
1537
|
+
/**
|
|
1538
|
+
* Outstanding Tasks
|
|
1539
|
+
* @description Number of outstanding tasks
|
|
1540
|
+
*/
|
|
1541
|
+
outstanding_tasks: number;
|
|
1542
|
+
/**
|
|
1543
|
+
* Managers
|
|
1544
|
+
* @description Number of managers
|
|
1545
|
+
*/
|
|
1546
|
+
managers?: number;
|
|
1547
|
+
};
|
|
1548
|
+
/**
|
|
1549
|
+
* EndpointStatusResponse
|
|
1550
|
+
* @example {
|
|
1551
|
+
* "details": {
|
|
1552
|
+
* "total_workers": 1,
|
|
1553
|
+
* "idle_workers": 0,
|
|
1554
|
+
* "pending_tasks": 0,
|
|
1555
|
+
* "outstanding_tasks": 0,
|
|
1556
|
+
* "managers": 1
|
|
1557
|
+
* },
|
|
1558
|
+
* "status": "online"
|
|
1559
|
+
* }
|
|
1560
|
+
*/
|
|
1561
|
+
EndpointStatusResponse: {
|
|
1562
|
+
details?: components["schemas"]["EndpointStatusDetails"];
|
|
1563
|
+
/**
|
|
1564
|
+
* Status
|
|
1565
|
+
* @description Endpoint status
|
|
1566
|
+
*/
|
|
1567
|
+
status: string;
|
|
1568
|
+
};
|
|
1569
|
+
/** ErrorResponse */
|
|
1570
|
+
ErrorResponse: {
|
|
1571
|
+
/** Status */
|
|
1572
|
+
status: string;
|
|
1573
|
+
/** Code */
|
|
1574
|
+
code: string;
|
|
1575
|
+
/** Error Args */
|
|
1576
|
+
error_args: unknown[];
|
|
1577
|
+
/** Http Status Code */
|
|
1578
|
+
http_status_code: number;
|
|
1579
|
+
/** Reason */
|
|
1580
|
+
reason: string;
|
|
1581
|
+
};
|
|
1582
|
+
/**
|
|
1583
|
+
* Function
|
|
1584
|
+
* @example {
|
|
1585
|
+
* "function_uuid": "11291b86-4f9c-47cb-848e-d3c06285951c",
|
|
1586
|
+
* "function_name": "My Function",
|
|
1587
|
+
* "function_code": "wuX2RpbGyUjBBfY3JlYXRlX2Z1bmN0 ...",
|
|
1588
|
+
* "description": "My first function",
|
|
1589
|
+
* "metadata": {
|
|
1590
|
+
* "python_version": "3.11.3",
|
|
1591
|
+
* "sdk_version": "2.3.3"
|
|
1592
|
+
* }
|
|
1593
|
+
* }
|
|
1594
|
+
*/
|
|
1595
|
+
Function: {
|
|
1596
|
+
/**
|
|
1597
|
+
* Function Uuid
|
|
1598
|
+
* Format: uuid
|
|
1599
|
+
* @description Function UUID
|
|
1600
|
+
*/
|
|
1601
|
+
function_uuid: string;
|
|
1602
|
+
/**
|
|
1603
|
+
* Function Name
|
|
1604
|
+
* @description Function name
|
|
1605
|
+
*/
|
|
1606
|
+
function_name?: string;
|
|
1607
|
+
/**
|
|
1608
|
+
* Description
|
|
1609
|
+
* @description Function description
|
|
1610
|
+
*/
|
|
1611
|
+
description?: string;
|
|
1612
|
+
/**
|
|
1613
|
+
* Function Code
|
|
1614
|
+
* @description Serialized function source code
|
|
1615
|
+
*/
|
|
1616
|
+
function_code: string;
|
|
1617
|
+
/**
|
|
1618
|
+
* Metadata
|
|
1619
|
+
* @description Function metadata
|
|
1620
|
+
*/
|
|
1621
|
+
metadata: components["schemas"]["FunctionMetadata"];
|
|
1622
|
+
};
|
|
1623
|
+
/** FunctionMetadata */
|
|
1624
|
+
FunctionMetadata: {
|
|
1625
|
+
/**
|
|
1626
|
+
* Python Version
|
|
1627
|
+
* @description Python version used to serialize function.
|
|
1628
|
+
*/
|
|
1629
|
+
python_version?: string;
|
|
1630
|
+
/**
|
|
1631
|
+
* Sdk Version
|
|
1632
|
+
* @description SDK version used to serialize function.
|
|
1633
|
+
*/
|
|
1634
|
+
sdk_version?: string;
|
|
1635
|
+
};
|
|
1636
|
+
/**
|
|
1637
|
+
* FuncxStatsResponse
|
|
1638
|
+
* @example {
|
|
1639
|
+
* "total_function_invocations": 100
|
|
1640
|
+
* }
|
|
1641
|
+
*/
|
|
1642
|
+
FuncxStatsResponse: {
|
|
1643
|
+
/**
|
|
1644
|
+
* Total Function Invocations
|
|
1645
|
+
* @description Total function invocations
|
|
1646
|
+
*/
|
|
1647
|
+
total_function_invocations: number;
|
|
1648
|
+
};
|
|
1649
|
+
/**
|
|
1650
|
+
* FuncxVersionResponse
|
|
1651
|
+
* @example {
|
|
1652
|
+
* "api": "1.0.9",
|
|
1653
|
+
* "min_sdk_version": "1.0.10",
|
|
1654
|
+
* "min_ep_version": "1.0.10",
|
|
1655
|
+
* "git_sha": "3ae0ff6bc42b6d5f9d92f3c426fe9e535a841hb6",
|
|
1656
|
+
* "container_service": "0.0.1"
|
|
1657
|
+
* }
|
|
1658
|
+
*/
|
|
1659
|
+
FuncxVersionResponse: {
|
|
1660
|
+
/**
|
|
1661
|
+
* Api
|
|
1662
|
+
* @description API version
|
|
1663
|
+
*/
|
|
1664
|
+
api: string;
|
|
1665
|
+
/**
|
|
1666
|
+
* Min Sdk Version
|
|
1667
|
+
* @description Minimum SDK version
|
|
1668
|
+
*/
|
|
1669
|
+
min_sdk_version?: string;
|
|
1670
|
+
/**
|
|
1671
|
+
* Min Ep Version
|
|
1672
|
+
* @description Minimum endpoint version
|
|
1673
|
+
*/
|
|
1674
|
+
min_ep_version?: string;
|
|
1675
|
+
/**
|
|
1676
|
+
* Git Sha
|
|
1677
|
+
* @description Git SHA of the latest commit
|
|
1678
|
+
*/
|
|
1679
|
+
git_sha?: string;
|
|
1680
|
+
/**
|
|
1681
|
+
* Container Service
|
|
1682
|
+
* @description Container service version
|
|
1683
|
+
*/
|
|
1684
|
+
container_service?: string;
|
|
1685
|
+
};
|
|
1686
|
+
/** HTTPValidationError */
|
|
1687
|
+
HTTPValidationError: {
|
|
1688
|
+
/** Detail */
|
|
1689
|
+
detail?: components["schemas"]["ValidationError"][];
|
|
1690
|
+
};
|
|
1691
|
+
/** MultiUserEndpointConfig */
|
|
1692
|
+
MultiUserEndpointConfig: {
|
|
1693
|
+
/**
|
|
1694
|
+
* Endpoint Id
|
|
1695
|
+
* Format: uuid
|
|
1696
|
+
* @description Endpoint UUID
|
|
1697
|
+
*/
|
|
1698
|
+
endpoint_id: string;
|
|
1699
|
+
command_queue_info: components["schemas"]["EndpointConfigQueueInfo"];
|
|
1700
|
+
/**
|
|
1701
|
+
* Warnings
|
|
1702
|
+
* @description Warnings
|
|
1703
|
+
*/
|
|
1704
|
+
warnings?: string[];
|
|
1705
|
+
};
|
|
1706
|
+
/**
|
|
1707
|
+
* MultiUserEndpointRegisterResponse
|
|
1708
|
+
* @example {
|
|
1709
|
+
* "endpoint_id": "7348422a-1074-427b-a08a-0771068afccc",
|
|
1710
|
+
* "command_queue_info": {
|
|
1711
|
+
* "connection_url": "amqps://user:password@mq.fqdn",
|
|
1712
|
+
* "exchange": "some_exchange",
|
|
1713
|
+
* "queue": "some_queue"
|
|
1714
|
+
* },
|
|
1715
|
+
* "result_queue_info": {
|
|
1716
|
+
* "connection_url": "amqps://user:password@mq.fqdn",
|
|
1717
|
+
* "exchange": "some_exchange",
|
|
1718
|
+
* "queue": "some_queue",
|
|
1719
|
+
* "queue_publish_kwargs": {
|
|
1720
|
+
* "exchange": "some_exchange",
|
|
1721
|
+
* "routing_key": "some_key",
|
|
1722
|
+
* "mandatory": true,
|
|
1723
|
+
* "properties": {
|
|
1724
|
+
* "delivery_mode": 2
|
|
1725
|
+
* }
|
|
1726
|
+
* }
|
|
1727
|
+
* },
|
|
1728
|
+
* "heartbeat_queue_info": {
|
|
1729
|
+
* "connection_url": "amqps://user:password@mq.fqdn",
|
|
1730
|
+
* "exchange": "some_exchange",
|
|
1731
|
+
* "queue": "some_queue",
|
|
1732
|
+
* "queue_publish_kwargs": {
|
|
1733
|
+
* "exchange": "some_exchange",
|
|
1734
|
+
* "routing_key": "some_key",
|
|
1735
|
+
* "mandatory": true,
|
|
1736
|
+
* "properties": {
|
|
1737
|
+
* "delivery_mode": 2
|
|
1738
|
+
* }
|
|
1739
|
+
* }
|
|
1740
|
+
* }
|
|
1741
|
+
* }
|
|
1742
|
+
*/
|
|
1743
|
+
MultiUserEndpointRegisterResponse: {
|
|
1744
|
+
/**
|
|
1745
|
+
* Endpoint Id
|
|
1746
|
+
* Format: uuid
|
|
1747
|
+
* @description Endpoint UUID
|
|
1748
|
+
*/
|
|
1749
|
+
endpoint_id: string;
|
|
1750
|
+
command_queue_info: components["schemas"]["ReadQueueInfo"];
|
|
1751
|
+
result_queue_info: components["schemas"]["WriteQueueInfo"];
|
|
1752
|
+
heartbeat_queue_info: components["schemas"]["WriteQueueInfo"];
|
|
1753
|
+
/**
|
|
1754
|
+
* Warnings
|
|
1755
|
+
* @description Warnings
|
|
1756
|
+
*/
|
|
1757
|
+
warnings?: string[];
|
|
1758
|
+
};
|
|
1759
|
+
/** ReadQueueInfo */
|
|
1760
|
+
ReadQueueInfo: {
|
|
1761
|
+
/**
|
|
1762
|
+
* Connection Url
|
|
1763
|
+
* @description Connection URL
|
|
1764
|
+
*/
|
|
1765
|
+
connection_url: string;
|
|
1766
|
+
/**
|
|
1767
|
+
* Exchange
|
|
1768
|
+
* @description Exchange
|
|
1769
|
+
*/
|
|
1770
|
+
exchange: string;
|
|
1771
|
+
/**
|
|
1772
|
+
* Queue
|
|
1773
|
+
* @description Queue
|
|
1774
|
+
*/
|
|
1775
|
+
queue: string;
|
|
1776
|
+
};
|
|
1777
|
+
/**
|
|
1778
|
+
* RegisterFunctionResponse
|
|
1779
|
+
* @example {
|
|
1780
|
+
* "function_uuid": "11291b86-4f9c-47cb-848e-d3c06285951c"
|
|
1781
|
+
* }
|
|
1782
|
+
*/
|
|
1783
|
+
RegisterFunctionResponse: {
|
|
1784
|
+
/**
|
|
1785
|
+
* Function Uuid
|
|
1786
|
+
* Format: uuid
|
|
1787
|
+
* @description Function UUID
|
|
1788
|
+
*/
|
|
1789
|
+
function_uuid: string;
|
|
1790
|
+
};
|
|
1791
|
+
/** ResourceSpecification */
|
|
1792
|
+
ResourceSpecification: {
|
|
1793
|
+
/**
|
|
1794
|
+
* Num Nodes
|
|
1795
|
+
* @description Number of nodes required for an MPI application
|
|
1796
|
+
*/
|
|
1797
|
+
num_nodes: number;
|
|
1798
|
+
/**
|
|
1799
|
+
* Ranks Per Node
|
|
1800
|
+
* @description Number of MPI ranks to launch per node.
|
|
1801
|
+
*/
|
|
1802
|
+
ranks_per_node?: number;
|
|
1803
|
+
/**
|
|
1804
|
+
* Num Ranks
|
|
1805
|
+
* @description Total number of MPI ranks to launch across all nodes.
|
|
1806
|
+
*/
|
|
1807
|
+
num_ranks?: number;
|
|
1808
|
+
/**
|
|
1809
|
+
* Launcher Options
|
|
1810
|
+
* @description Options passed through to the MPI launcher command line prefix.
|
|
1811
|
+
*/
|
|
1812
|
+
launcher_options?: string;
|
|
1813
|
+
};
|
|
1814
|
+
/**
|
|
1815
|
+
* ResultAmqpUrlResponse
|
|
1816
|
+
* @example {
|
|
1817
|
+
* "queue_prefix": "some_prefix",
|
|
1818
|
+
* "connection_url": "amqps://user:password@amq.fqdn"
|
|
1819
|
+
* }
|
|
1820
|
+
*/
|
|
1821
|
+
ResultAmqpUrlResponse: {
|
|
1822
|
+
/**
|
|
1823
|
+
* Queue Prefix
|
|
1824
|
+
* @description Queue prefix
|
|
1825
|
+
*/
|
|
1826
|
+
queue_prefix: string;
|
|
1827
|
+
/**
|
|
1828
|
+
* Connection Url
|
|
1829
|
+
* Format: uri
|
|
1830
|
+
* @description Connection URL
|
|
1831
|
+
*/
|
|
1832
|
+
connection_url: string;
|
|
1833
|
+
};
|
|
1834
|
+
/**
|
|
1835
|
+
* TaskGroupResponse
|
|
1836
|
+
* @example {
|
|
1837
|
+
* "taskgroup_id": "4defbef8-0a1a-4c7b-9c83-b59174fca395",
|
|
1838
|
+
* "create_websockets_queue": true,
|
|
1839
|
+
* "tasks": [
|
|
1840
|
+
* {
|
|
1841
|
+
* "id": "9e38ed49-7d05-45c4-9ad0-bfa3bc92d6a1",
|
|
1842
|
+
* "created_at": "2021-05-05T15:00:00.000000"
|
|
1843
|
+
* }
|
|
1844
|
+
* ]
|
|
1845
|
+
* }
|
|
1846
|
+
*/
|
|
1847
|
+
TaskGroupResponse: {
|
|
1848
|
+
/**
|
|
1849
|
+
* Taskgroup Id
|
|
1850
|
+
* Format: uuid
|
|
1851
|
+
* @description Task Group UUID
|
|
1852
|
+
*/
|
|
1853
|
+
taskgroup_id: string;
|
|
1854
|
+
/**
|
|
1855
|
+
* Create Websockets Queue
|
|
1856
|
+
* @description Create websockets queue
|
|
1857
|
+
*/
|
|
1858
|
+
create_websockets_queue?: boolean;
|
|
1859
|
+
/** Tasks */
|
|
1860
|
+
tasks: components["schemas"]["TaskGroupResponseTask"][];
|
|
1861
|
+
};
|
|
1862
|
+
/** TaskGroupResponseTask */
|
|
1863
|
+
TaskGroupResponseTask: {
|
|
1864
|
+
/**
|
|
1865
|
+
* Id
|
|
1866
|
+
* Format: uuid
|
|
1867
|
+
* @description Task UUID
|
|
1868
|
+
*/
|
|
1869
|
+
id: string;
|
|
1870
|
+
/**
|
|
1871
|
+
* Created At
|
|
1872
|
+
* Format: date-time
|
|
1873
|
+
* @description Task creation time
|
|
1874
|
+
*/
|
|
1875
|
+
created_at: string;
|
|
1876
|
+
};
|
|
1877
|
+
/**
|
|
1878
|
+
* TaskStatusResponse
|
|
1879
|
+
* @example {
|
|
1880
|
+
* "task_id": "7dac44aa-c480-4460-b453-a47b03b031f4",
|
|
1881
|
+
* "status": "success",
|
|
1882
|
+
* "result": "10000",
|
|
1883
|
+
* "completion_t": "1677183605.212898",
|
|
1884
|
+
* "details": {
|
|
1885
|
+
* "os": "Linux-5.19.0-1025-aws-x86_64-with-glibc2.35",
|
|
1886
|
+
* "python_version": "3.10.4",
|
|
1887
|
+
* "dill_version": "0.3.5.1",
|
|
1888
|
+
* "globus_compute_sdk_version": "2.3.2",
|
|
1889
|
+
* "task_transitions": {
|
|
1890
|
+
* "execution-start": 1692742841.843334,
|
|
1891
|
+
* "execution-end": 1692742846.123456
|
|
1892
|
+
* }
|
|
1893
|
+
* }
|
|
1894
|
+
* }
|
|
1895
|
+
*/
|
|
1896
|
+
TaskStatusResponse: {
|
|
1897
|
+
/**
|
|
1898
|
+
* Task Id
|
|
1899
|
+
* Format: uuid
|
|
1900
|
+
* @description Task UUID
|
|
1901
|
+
*/
|
|
1902
|
+
task_id: string;
|
|
1903
|
+
/**
|
|
1904
|
+
* Status
|
|
1905
|
+
* @description Task status
|
|
1906
|
+
*/
|
|
1907
|
+
status?: unknown;
|
|
1908
|
+
/**
|
|
1909
|
+
* Result
|
|
1910
|
+
* @description Task result
|
|
1911
|
+
*/
|
|
1912
|
+
result?: string;
|
|
1913
|
+
/**
|
|
1914
|
+
* Completion T
|
|
1915
|
+
* @description Task completion Unix time
|
|
1916
|
+
*/
|
|
1917
|
+
completion_t?: string;
|
|
1918
|
+
/**
|
|
1919
|
+
* Exception
|
|
1920
|
+
* @description Exception
|
|
1921
|
+
*/
|
|
1922
|
+
exception?: string;
|
|
1923
|
+
/**
|
|
1924
|
+
* Details
|
|
1925
|
+
* @description Task execution details
|
|
1926
|
+
*/
|
|
1927
|
+
details?: Record<string, unknown>;
|
|
1928
|
+
};
|
|
1929
|
+
/** UserRuntime */
|
|
1930
|
+
UserRuntime: {
|
|
1931
|
+
/**
|
|
1932
|
+
* Globus Compute Sdk Version
|
|
1933
|
+
* @description Version of the Globus Compute SDK used to submit this batch.
|
|
1934
|
+
*/
|
|
1935
|
+
globus_compute_sdk_version?: string;
|
|
1936
|
+
/**
|
|
1937
|
+
* Globus Sdk Version
|
|
1938
|
+
* @description Version of the Globus SDK used to submit this batch.
|
|
1939
|
+
*/
|
|
1940
|
+
globus_sdk_version?: string;
|
|
1941
|
+
/**
|
|
1942
|
+
* Python Version
|
|
1943
|
+
* @description Python version that ran the SDK and submitted this batch.
|
|
1944
|
+
*/
|
|
1945
|
+
python_version?: string;
|
|
1946
|
+
};
|
|
1947
|
+
/** ValidationError */
|
|
1948
|
+
ValidationError: {
|
|
1949
|
+
/** Location */
|
|
1950
|
+
loc: (string | number)[];
|
|
1951
|
+
/** Message */
|
|
1952
|
+
msg: string;
|
|
1953
|
+
/** Error Type */
|
|
1954
|
+
type: string;
|
|
1955
|
+
};
|
|
1956
|
+
/** ValidationErrorResponse */
|
|
1957
|
+
ValidationErrorResponse: {
|
|
1958
|
+
/** Status */
|
|
1959
|
+
status: string;
|
|
1960
|
+
/** Code */
|
|
1961
|
+
code: string;
|
|
1962
|
+
/** Error Args */
|
|
1963
|
+
error_args: unknown[];
|
|
1964
|
+
/** Http Status Code */
|
|
1965
|
+
http_status_code: number;
|
|
1966
|
+
/** Reason */
|
|
1967
|
+
reason: components["schemas"]["ValidationError"][];
|
|
1968
|
+
};
|
|
1969
|
+
/**
|
|
1970
|
+
* VersionService
|
|
1971
|
+
* @description An enumeration.
|
|
1972
|
+
* @enum {string}
|
|
1973
|
+
*/
|
|
1974
|
+
VersionService: "api" | "all";
|
|
1975
|
+
/** WriteQueueInfo */
|
|
1976
|
+
WriteQueueInfo: {
|
|
1977
|
+
/**
|
|
1978
|
+
* Connection Url
|
|
1979
|
+
* @description Connection URL
|
|
1980
|
+
*/
|
|
1981
|
+
connection_url: string;
|
|
1982
|
+
/**
|
|
1983
|
+
* Exchange
|
|
1984
|
+
* @description Exchange
|
|
1985
|
+
*/
|
|
1986
|
+
exchange: string;
|
|
1987
|
+
/**
|
|
1988
|
+
* Queue
|
|
1989
|
+
* @description Queue
|
|
1990
|
+
*/
|
|
1991
|
+
queue: string;
|
|
1992
|
+
queue_publish_kwargs: components["schemas"]["WriteQueuePublishKwargs"];
|
|
1993
|
+
};
|
|
1994
|
+
/** WriteQueuePublishKwargs */
|
|
1995
|
+
WriteQueuePublishKwargs: {
|
|
1996
|
+
/**
|
|
1997
|
+
* Exchange
|
|
1998
|
+
* @description Exchange
|
|
1999
|
+
*/
|
|
2000
|
+
exchange: string;
|
|
2001
|
+
/**
|
|
2002
|
+
* Routing Key
|
|
2003
|
+
* @description Routing key
|
|
2004
|
+
*/
|
|
2005
|
+
routing_key: string;
|
|
2006
|
+
/**
|
|
2007
|
+
* Mandatory
|
|
2008
|
+
* @description Mandatory
|
|
2009
|
+
*/
|
|
2010
|
+
mandatory: boolean;
|
|
2011
|
+
properties: components["schemas"]["WriteQueuePublishProperties"];
|
|
2012
|
+
};
|
|
2013
|
+
/** WriteQueuePublishProperties */
|
|
2014
|
+
WriteQueuePublishProperties: {
|
|
2015
|
+
/**
|
|
2016
|
+
* Delivery Mode
|
|
2017
|
+
* @description Delivery mode
|
|
2018
|
+
*/
|
|
2019
|
+
delivery_mode: number;
|
|
2020
|
+
};
|
|
2021
|
+
/**
|
|
2022
|
+
* EndpointLockResponse
|
|
2023
|
+
* @example {
|
|
2024
|
+
* "endpoint_id": "7348422a-1074-427b-a08a-0771068afccc",
|
|
2025
|
+
* "lock_expiration_timestamp": "2021-07-01T00:00:00.000000"
|
|
2026
|
+
* }
|
|
2027
|
+
*/
|
|
2028
|
+
funcx_web_service__schemas__v2__endpoint__EndpointLockResponse: {
|
|
2029
|
+
/**
|
|
2030
|
+
* Endpoint Id
|
|
2031
|
+
* Format: uuid
|
|
2032
|
+
* @description Endpoint UUID
|
|
2033
|
+
*/
|
|
2034
|
+
endpoint_id: string;
|
|
2035
|
+
/**
|
|
2036
|
+
* Lock Expiration Timestamp
|
|
2037
|
+
* Format: date-time
|
|
2038
|
+
* @description Lock expiration timestamp
|
|
2039
|
+
*/
|
|
2040
|
+
lock_expiration_timestamp: string;
|
|
2041
|
+
};
|
|
2042
|
+
/**
|
|
2043
|
+
* EndpointRegisterRequest
|
|
2044
|
+
* @example {
|
|
2045
|
+
* "endpoint_name": "My Endpoint",
|
|
2046
|
+
* "display_name": "My Endpoint's display name",
|
|
2047
|
+
* "endpoint_uuid": "7348422a-1074-427b-a08a-0771068afccc",
|
|
2048
|
+
* "version": "1.0.10",
|
|
2049
|
+
* "multi_user": false,
|
|
2050
|
+
* "allowed_functions": [
|
|
2051
|
+
* "11291b86-4f9c-47cb-848e-d3c06285951c"
|
|
2052
|
+
* ],
|
|
2053
|
+
* "authentication_policy": "67b4e120-2638-4771-86bb-6ac2a0f69e0b",
|
|
2054
|
+
* "metadata": {
|
|
2055
|
+
* "endpoint_config": "",
|
|
2056
|
+
* "user_config_template": {},
|
|
2057
|
+
* "user_config_schema": {},
|
|
2058
|
+
* "description": "My endpoint description",
|
|
2059
|
+
* "ip_address": "140.221.112.13",
|
|
2060
|
+
* "hostname": "my-endpoint",
|
|
2061
|
+
* "local_user": "user",
|
|
2062
|
+
* "sdk_version": "1.0.10",
|
|
2063
|
+
* "endpoint_version": "1.0.10",
|
|
2064
|
+
* "python_version": "3.12.7"
|
|
2065
|
+
* }
|
|
2066
|
+
* }
|
|
2067
|
+
*/
|
|
2068
|
+
funcx_web_service__schemas__v2__endpoint__EndpointRegisterRequest: {
|
|
2069
|
+
/**
|
|
2070
|
+
* Endpoint Name
|
|
2071
|
+
* @description Endpoint name
|
|
2072
|
+
*/
|
|
2073
|
+
endpoint_name: string;
|
|
2074
|
+
/**
|
|
2075
|
+
* Display Name
|
|
2076
|
+
* @description Endpoint display name
|
|
2077
|
+
*/
|
|
2078
|
+
display_name?: string;
|
|
2079
|
+
/**
|
|
2080
|
+
* Endpoint Uuid
|
|
2081
|
+
* Format: uuid
|
|
2082
|
+
* @description Endpoint UUID
|
|
2083
|
+
*/
|
|
2084
|
+
endpoint_uuid: string;
|
|
2085
|
+
/**
|
|
2086
|
+
* Version
|
|
2087
|
+
* @description Endpoint version
|
|
2088
|
+
*/
|
|
2089
|
+
version?: string;
|
|
2090
|
+
/**
|
|
2091
|
+
* Multi User
|
|
2092
|
+
* @description Endpoint multi-user mode
|
|
2093
|
+
* @default false
|
|
2094
|
+
*/
|
|
2095
|
+
multi_user: boolean;
|
|
2096
|
+
/**
|
|
2097
|
+
* Allowed Functions
|
|
2098
|
+
* @description Functions that are allowed to be run on the endpoint
|
|
2099
|
+
*/
|
|
2100
|
+
allowed_functions?: string[];
|
|
2101
|
+
/**
|
|
2102
|
+
* Authentication Policy
|
|
2103
|
+
* Format: uuid
|
|
2104
|
+
* @description Endpoint users are evaluated against this Globus authentication policy. For more information on Globus authentication policies, visit https://docs.globus.org/api/auth/developer-guide/#authentication-policies.
|
|
2105
|
+
*/
|
|
2106
|
+
authentication_policy?: string;
|
|
2107
|
+
metadata?: components["schemas"]["EndpointRegisterMetadata"];
|
|
2108
|
+
};
|
|
2109
|
+
/** RegisterFunctionMetadata */
|
|
2110
|
+
funcx_web_service__schemas__v2__function__RegisterFunctionMetadata: {
|
|
2111
|
+
/**
|
|
2112
|
+
* Python Version
|
|
2113
|
+
* @description Python version used to serialize function.
|
|
2114
|
+
*/
|
|
2115
|
+
python_version?: string;
|
|
2116
|
+
/**
|
|
2117
|
+
* Sdk Version
|
|
2118
|
+
* @description SDK version used to serialize function.
|
|
2119
|
+
*/
|
|
2120
|
+
sdk_version?: string;
|
|
2121
|
+
};
|
|
2122
|
+
/**
|
|
2123
|
+
* RegisterFunctionRequest
|
|
2124
|
+
* @example {
|
|
2125
|
+
* "function_name": "My Function",
|
|
2126
|
+
* "function_code": "wuX2RpbGyUjBBfY3JlYXRlX2Z1bmN0 ...",
|
|
2127
|
+
* "description": "My first function",
|
|
2128
|
+
* "metadata": {
|
|
2129
|
+
* "python_version": "3.11.3",
|
|
2130
|
+
* "sdk_version": "2.3.3"
|
|
2131
|
+
* },
|
|
2132
|
+
* "container_uuid": "b7a42fa2-e97f-4061-9e64-2ede22ae7f5e",
|
|
2133
|
+
* "group": "a2d6feb6-5386-4a06-8a22-99ea5ad7e651",
|
|
2134
|
+
* "public": false
|
|
2135
|
+
* }
|
|
2136
|
+
*/
|
|
2137
|
+
funcx_web_service__schemas__v2__function__RegisterFunctionRequest: {
|
|
2138
|
+
/**
|
|
2139
|
+
* Function Name
|
|
2140
|
+
* @description Function name
|
|
2141
|
+
*/
|
|
2142
|
+
function_name: string;
|
|
2143
|
+
/**
|
|
2144
|
+
* Entry Point
|
|
2145
|
+
* @description (DEPRECATED) Entry point
|
|
2146
|
+
*/
|
|
2147
|
+
entry_point?: string;
|
|
2148
|
+
/**
|
|
2149
|
+
* Function Code
|
|
2150
|
+
* @description Serialized function source code
|
|
2151
|
+
*/
|
|
2152
|
+
function_code: string;
|
|
2153
|
+
/**
|
|
2154
|
+
* Description
|
|
2155
|
+
* @description Function description
|
|
2156
|
+
*/
|
|
2157
|
+
description?: string;
|
|
2158
|
+
metadata?: components["schemas"]["funcx_web_service__schemas__v2__function__RegisterFunctionMetadata"];
|
|
2159
|
+
/**
|
|
2160
|
+
* Container Uuid
|
|
2161
|
+
* Format: uuid
|
|
2162
|
+
* @description Container UUID
|
|
2163
|
+
*/
|
|
2164
|
+
container_uuid?: string;
|
|
2165
|
+
/**
|
|
2166
|
+
* Group
|
|
2167
|
+
* Format: uuid
|
|
2168
|
+
* @description Globus group UUID
|
|
2169
|
+
*/
|
|
2170
|
+
group?: string;
|
|
2171
|
+
/**
|
|
2172
|
+
* Public
|
|
2173
|
+
* @description Public function
|
|
2174
|
+
* @default false
|
|
2175
|
+
*/
|
|
2176
|
+
public: boolean;
|
|
2177
|
+
};
|
|
2178
|
+
/**
|
|
2179
|
+
* BatchSubmitRequest
|
|
2180
|
+
* @example {
|
|
2181
|
+
* "task_group_id": "97241626-8ff4-4550-9938-5909bd221869",
|
|
2182
|
+
* "create_websocket_queue": false,
|
|
2183
|
+
* "tasks": [
|
|
2184
|
+
* [
|
|
2185
|
+
* "116f1b48-0aab-4228-92f0-021c2ab14b5e",
|
|
2186
|
+
* "ff960aba-fa23-43d5-9cbe-3f4f91a066e1",
|
|
2187
|
+
* "... <serialized_arguments> ..."
|
|
2188
|
+
* ],
|
|
2189
|
+
* [
|
|
2190
|
+
* "116f1b48-0aab-4228-92f0-021c2ab14b5e",
|
|
2191
|
+
* "ff960aba-fa23-43d5-9cbe-3f4f91a066e1",
|
|
2192
|
+
* "... <serialized_arguments> ..."
|
|
2193
|
+
* ]
|
|
2194
|
+
* ]
|
|
2195
|
+
* }
|
|
2196
|
+
*/
|
|
2197
|
+
funcx_web_service__schemas__v2__task__BatchSubmitRequest: {
|
|
2198
|
+
/**
|
|
2199
|
+
* Task Group Id
|
|
2200
|
+
* Format: uuid
|
|
2201
|
+
* @description Task group UUID
|
|
2202
|
+
*/
|
|
2203
|
+
task_group_id?: string;
|
|
2204
|
+
/**
|
|
2205
|
+
* Create Websocket Queue
|
|
2206
|
+
* @description Create websocket queue
|
|
2207
|
+
* @default true
|
|
2208
|
+
*/
|
|
2209
|
+
create_websocket_queue: boolean;
|
|
2210
|
+
/**
|
|
2211
|
+
* Tasks
|
|
2212
|
+
* @description List of tasks to invoke, each referencing function and endpoint UUIDs.
|
|
2213
|
+
*/
|
|
2214
|
+
tasks: [
|
|
2215
|
+
string,
|
|
2216
|
+
string,
|
|
2217
|
+
string
|
|
2218
|
+
][];
|
|
2219
|
+
};
|
|
2220
|
+
/**
|
|
2221
|
+
* BatchSubmitResponse
|
|
2222
|
+
* @example {
|
|
2223
|
+
* "response": "success",
|
|
2224
|
+
* "task_group_id": "97241626-8ff4-4550-9938-5909bd221869",
|
|
2225
|
+
* "results": [
|
|
2226
|
+
* {
|
|
2227
|
+
* "status": "success",
|
|
2228
|
+
* "task_uuid": "7dac44aa-c480-4460-b453-a47b03b031f4",
|
|
2229
|
+
* "http_status_code": 200
|
|
2230
|
+
* },
|
|
2231
|
+
* {
|
|
2232
|
+
* "status": "success",
|
|
2233
|
+
* "task_uuid": "4b35645f-0c5b-465d-aaec-fee87f74ff5b",
|
|
2234
|
+
* "http_status_code": 200
|
|
2235
|
+
* }
|
|
2236
|
+
* ]
|
|
2237
|
+
* }
|
|
2238
|
+
*/
|
|
2239
|
+
funcx_web_service__schemas__v2__task__BatchSubmitResponse: {
|
|
2240
|
+
/**
|
|
2241
|
+
* Response
|
|
2242
|
+
* @description Response
|
|
2243
|
+
*/
|
|
2244
|
+
response: string;
|
|
2245
|
+
/**
|
|
2246
|
+
* Task Group Id
|
|
2247
|
+
* Format: uuid
|
|
2248
|
+
* @description Task group UUID
|
|
2249
|
+
*/
|
|
2250
|
+
task_group_id?: string;
|
|
2251
|
+
/**
|
|
2252
|
+
* Results
|
|
2253
|
+
* @description Task results
|
|
2254
|
+
*/
|
|
2255
|
+
results: (components["schemas"]["BatchSubmitResponseTask"] | string)[];
|
|
2256
|
+
};
|
|
2257
|
+
/**
|
|
2258
|
+
* EndpointLockResponse
|
|
2259
|
+
* @example {
|
|
2260
|
+
* "endpoint_id": "7348422a-1074-427b-a08a-0771068afccc",
|
|
2261
|
+
* "lock_expiration_timestamp": "1687531403.0434475"
|
|
2262
|
+
* }
|
|
2263
|
+
*/
|
|
2264
|
+
funcx_web_service__schemas__v3__endpoints__EndpointLockResponse: {
|
|
2265
|
+
/**
|
|
2266
|
+
* Endpoint Id
|
|
2267
|
+
* Format: uuid
|
|
2268
|
+
* @description Endpoint UUID
|
|
2269
|
+
*/
|
|
2270
|
+
endpoint_id: string;
|
|
2271
|
+
/**
|
|
2272
|
+
* Lock Expiration Timestamp
|
|
2273
|
+
* @description Lock expiration UNIX timestamp
|
|
2274
|
+
*/
|
|
2275
|
+
lock_expiration_timestamp: number;
|
|
2276
|
+
};
|
|
2277
|
+
/**
|
|
2278
|
+
* EndpointRegisterRequest
|
|
2279
|
+
* @example {
|
|
2280
|
+
* "endpoint_name": "my_endpoint",
|
|
2281
|
+
* "display_name": "My Endpoint's Display Name",
|
|
2282
|
+
* "version": "2.2.0",
|
|
2283
|
+
* "multi_user": false,
|
|
2284
|
+
* "public": false,
|
|
2285
|
+
* "high_assurance": false,
|
|
2286
|
+
* "allowed_functions": [
|
|
2287
|
+
* "11291b86-4f9c-47cb-848e-d3c06285951c"
|
|
2288
|
+
* ],
|
|
2289
|
+
* "authentication_policy": "67b4e120-2638-4771-86bb-6ac2a0f69e0b",
|
|
2290
|
+
* "subscription_uuid": "59b63c41-a765-4971-ac9a-41742059ade3",
|
|
2291
|
+
* "metadata": {
|
|
2292
|
+
* "endpoint_config": "",
|
|
2293
|
+
* "user_config_template": {},
|
|
2294
|
+
* "user_config_schema": {},
|
|
2295
|
+
* "description": "My endpoint description",
|
|
2296
|
+
* "ip_address": "140.221.112.13",
|
|
2297
|
+
* "hostname": "my-endpoint",
|
|
2298
|
+
* "local_user": "user",
|
|
2299
|
+
* "sdk_version": "2.2.0",
|
|
2300
|
+
* "endpoint_version": "2.2.0",
|
|
2301
|
+
* "python_version": "3.12.7"
|
|
2302
|
+
* }
|
|
2303
|
+
* }
|
|
2304
|
+
*/
|
|
2305
|
+
funcx_web_service__schemas__v3__endpoints__EndpointRegisterRequest: {
|
|
2306
|
+
/**
|
|
2307
|
+
* Endpoint Name
|
|
2308
|
+
* @description Endpoint name
|
|
2309
|
+
*/
|
|
2310
|
+
endpoint_name: string;
|
|
2311
|
+
/**
|
|
2312
|
+
* Display Name
|
|
2313
|
+
* @description Endpoint display name
|
|
2314
|
+
*/
|
|
2315
|
+
display_name?: string;
|
|
2316
|
+
/**
|
|
2317
|
+
* Version
|
|
2318
|
+
* @description Endpoint version
|
|
2319
|
+
*/
|
|
2320
|
+
version?: string;
|
|
2321
|
+
/**
|
|
2322
|
+
* Multi User
|
|
2323
|
+
* @description Endpoint multi-user mode
|
|
2324
|
+
* @default false
|
|
2325
|
+
*/
|
|
2326
|
+
multi_user: boolean;
|
|
2327
|
+
/**
|
|
2328
|
+
* High Assurance
|
|
2329
|
+
* @description Endpoint supports high-assurance protocols
|
|
2330
|
+
* @default false
|
|
2331
|
+
*/
|
|
2332
|
+
high_assurance: boolean;
|
|
2333
|
+
/**
|
|
2334
|
+
* Allowed Functions
|
|
2335
|
+
* @description Functions that are allowed to be run on the endpoint
|
|
2336
|
+
*/
|
|
2337
|
+
allowed_functions?: string[];
|
|
2338
|
+
/**
|
|
2339
|
+
* Authentication Policy
|
|
2340
|
+
* Format: uuid
|
|
2341
|
+
* @description Endpoint users are evaluated against this Globus authentication policy. For more information on Globus authentication policies, visit https://docs.globus.org/api/auth/developer-guide/#authentication-policies.
|
|
2342
|
+
*/
|
|
2343
|
+
authentication_policy?: string;
|
|
2344
|
+
/**
|
|
2345
|
+
* Subscription Uuid
|
|
2346
|
+
* Format: uuid
|
|
2347
|
+
* @description Associates an endpoint with a subscription.
|
|
2348
|
+
*/
|
|
2349
|
+
subscription_uuid?: string;
|
|
2350
|
+
/**
|
|
2351
|
+
* Admins
|
|
2352
|
+
* @description A set of Globus Auth identity IDs that, in addition to the owner, have administrative access to the endpoint. This field requires an active Globus subscription (i.e., `subscription_uuid` field).
|
|
2353
|
+
*/
|
|
2354
|
+
admins?: string[];
|
|
2355
|
+
/**
|
|
2356
|
+
* Public
|
|
2357
|
+
* @description Indicates if all users can discover the multi-user endpoint. Please note that this field does not control access to the endpoint, so it should not be used as a security feature.
|
|
2358
|
+
* @default false
|
|
2359
|
+
*/
|
|
2360
|
+
public: boolean;
|
|
2361
|
+
/**
|
|
2362
|
+
* Metadata
|
|
2363
|
+
* @description Endpoint metadata
|
|
2364
|
+
*/
|
|
2365
|
+
metadata: components["schemas"]["EndpointMetadata"];
|
|
2366
|
+
};
|
|
2367
|
+
/** RegisterFunctionMetadata */
|
|
2368
|
+
funcx_web_service__schemas__v3__function__RegisterFunctionMetadata: {
|
|
2369
|
+
/**
|
|
2370
|
+
* Python Version
|
|
2371
|
+
* @description version used to serialize function
|
|
2372
|
+
*/
|
|
2373
|
+
python_version: string;
|
|
2374
|
+
/**
|
|
2375
|
+
* Globus Compute SDK version
|
|
2376
|
+
* @description version used to serialize function
|
|
2377
|
+
*/
|
|
2378
|
+
sdk_version: string;
|
|
2379
|
+
/**
|
|
2380
|
+
* Serde Identifier
|
|
2381
|
+
* @description Identifier of SDK method used to serialize the function; the identifiers are not currently specifically documented, but may be found in the [Globus Compute SDK repository](https://github.com/globus/globus-compute) as the `identifier` class variable of the respective [serializers](https://github.com/globus/globus-compute/tree/main/compute_sdk/globus_compute_sdk/serialize)
|
|
2382
|
+
*/
|
|
2383
|
+
serde_identifier: string;
|
|
2384
|
+
};
|
|
2385
|
+
/**
|
|
2386
|
+
* RegisterFunctionRequest
|
|
2387
|
+
* @example {
|
|
2388
|
+
* "function_name": "dot_product",
|
|
2389
|
+
* "function_code": "850\n01\ngASVZwIAAAAAAACMCmRpbGwuX2RpbGyUjBB...",
|
|
2390
|
+
* "description": "Dot product of two vectors (unchecked length)",
|
|
2391
|
+
* "metadata": {
|
|
2392
|
+
* "python_version": "3.13.3",
|
|
2393
|
+
* "sdk_version": "3.1.1",
|
|
2394
|
+
* "serde_identifier": "01"
|
|
2395
|
+
* },
|
|
2396
|
+
* "public": true
|
|
2397
|
+
* }
|
|
2398
|
+
*/
|
|
2399
|
+
funcx_web_service__schemas__v3__function__RegisterFunctionRequest: {
|
|
2400
|
+
/**
|
|
2401
|
+
* Function Name
|
|
2402
|
+
* @description Function name
|
|
2403
|
+
*/
|
|
2404
|
+
function_name: string;
|
|
2405
|
+
/**
|
|
2406
|
+
* Function Code
|
|
2407
|
+
* @description Serialized function source code
|
|
2408
|
+
*/
|
|
2409
|
+
function_code: string;
|
|
2410
|
+
/**
|
|
2411
|
+
* Description
|
|
2412
|
+
* @description Function description
|
|
2413
|
+
*/
|
|
2414
|
+
description?: string;
|
|
2415
|
+
/**
|
|
2416
|
+
* Meta
|
|
2417
|
+
* @description Function metadata
|
|
2418
|
+
*/
|
|
2419
|
+
meta: components["schemas"]["funcx_web_service__schemas__v3__function__RegisterFunctionMetadata"];
|
|
2420
|
+
/**
|
|
2421
|
+
* Group
|
|
2422
|
+
* Format: uuid
|
|
2423
|
+
* @description If specified, this function will be accessible to members of the [Globus Group](https://docs.globus.org/api/groups/) specified by this identifier
|
|
2424
|
+
*/
|
|
2425
|
+
group?: string;
|
|
2426
|
+
/**
|
|
2427
|
+
* Public
|
|
2428
|
+
* @description If true, this function will be accessible to any registered user
|
|
2429
|
+
* @default false
|
|
2430
|
+
*/
|
|
2431
|
+
public: boolean;
|
|
2432
|
+
/**
|
|
2433
|
+
* Ha Endpoint Id
|
|
2434
|
+
* Format: uuid
|
|
2435
|
+
* @description Users will only be able to run this function on the specified HA endpoint. Since HA functions cannot be shared, this field is mutually exclusive with the `group` and `public` fields.
|
|
2436
|
+
*/
|
|
2437
|
+
ha_endpoint_id?: string;
|
|
2438
|
+
};
|
|
2439
|
+
/**
|
|
2440
|
+
* BatchSubmitRequest
|
|
2441
|
+
* @example {
|
|
2442
|
+
* "task_group_id": "97241626-8ff4-4550-9938-5909bd221869",
|
|
2443
|
+
* "user_endpoint_config": {
|
|
2444
|
+
* "min_blocks": 0,
|
|
2445
|
+
* "max_blocks": 1,
|
|
2446
|
+
* "scheduler_options": "#SBATCH --constraint=knl,quad,cache"
|
|
2447
|
+
* },
|
|
2448
|
+
* "resource_specification": {
|
|
2449
|
+
* "num_nodes": 2,
|
|
2450
|
+
* "ranks_per_node": 2,
|
|
2451
|
+
* "num_ranks": 4,
|
|
2452
|
+
* "launcher_options": "--cpu-bind quiet --mem 3072"
|
|
2453
|
+
* },
|
|
2454
|
+
* "result_serializers": [
|
|
2455
|
+
* "globus_compute_sdk.serialize.JSONData",
|
|
2456
|
+
* "globus_compute_sdk.serialize.DillDataBase64"
|
|
2457
|
+
* ],
|
|
2458
|
+
* "create_queue": true,
|
|
2459
|
+
* "tasks": {
|
|
2460
|
+
* "ff960aba-fa23-43d5-9cbe-3f4f91a066e1": [
|
|
2461
|
+
* "... <serialized_arguments> ...",
|
|
2462
|
+
* "... <serialized_arguments> ...",
|
|
2463
|
+
* "..."
|
|
2464
|
+
* ],
|
|
2465
|
+
* "0a98fd06-edbd-11ed-abcd-0d705ebb4c49": [
|
|
2466
|
+
* "... <serialized_arguments> ...",
|
|
2467
|
+
* "..."
|
|
2468
|
+
* ]
|
|
2469
|
+
* }
|
|
2470
|
+
* }
|
|
2471
|
+
*/
|
|
2472
|
+
funcx_web_service__schemas__v3__tasks__BatchSubmitRequest: {
|
|
2473
|
+
/**
|
|
2474
|
+
* Task Group Id
|
|
2475
|
+
* Format: uuid
|
|
2476
|
+
* @description Associate the request tasks with specified Task Group identifier; if not specified or invalid, a new identifier will be generated and returned in the response
|
|
2477
|
+
*/
|
|
2478
|
+
task_group_id?: string;
|
|
2479
|
+
/**
|
|
2480
|
+
* User Endpoint Config
|
|
2481
|
+
* @description Specify user endpoint configuration values as described and allowed by endpoint administrators.
|
|
2482
|
+
*/
|
|
2483
|
+
user_endpoint_config?: Record<string, unknown>;
|
|
2484
|
+
/**
|
|
2485
|
+
* Resource Specification
|
|
2486
|
+
* @description Specify resource requirements for individual task execution.
|
|
2487
|
+
*/
|
|
2488
|
+
resource_specification?: components["schemas"]["ResourceSpecification"];
|
|
2489
|
+
/**
|
|
2490
|
+
* Create Queue
|
|
2491
|
+
* @description If `true`, create a Task Group specific AMQP queue for the results. In addition to the usual longer-term storage, results will also be copied to this AMQP queue, enabling consumers to get event-driven (instant) results. (See the [Globus Compute SDK Executor](https://globus-compute.readthedocs.io/en/stable/executor.html) for an implementation that uses this feature.)
|
|
2492
|
+
* @default false
|
|
2493
|
+
*/
|
|
2494
|
+
create_queue: boolean;
|
|
2495
|
+
/**
|
|
2496
|
+
* Tasks
|
|
2497
|
+
* @description Lists of serialized task arguments (strings), grouped by function identifiers
|
|
2498
|
+
*/
|
|
2499
|
+
tasks: {
|
|
2500
|
+
[key: string]: string[];
|
|
2501
|
+
};
|
|
2502
|
+
/**
|
|
2503
|
+
* User Runtime
|
|
2504
|
+
* @description Information about the runtime that submitted this batch, such as Python and Globus Compute SDK versions.
|
|
2505
|
+
*/
|
|
2506
|
+
user_runtime?: components["schemas"]["UserRuntime"];
|
|
2507
|
+
/**
|
|
2508
|
+
* Result Serializers
|
|
2509
|
+
* @description A list of import paths to [SerializationStrategy](https://globus-compute.readthedocs.io/en/stable/reference/serialization_strategies.html#globus_compute_sdk.serialize.SerializationStrategy) subclasses that the endpoint is allowed to use when serializing results.
|
|
2510
|
+
*/
|
|
2511
|
+
result_serializers?: string[];
|
|
2512
|
+
};
|
|
2513
|
+
/**
|
|
2514
|
+
* BatchSubmitResponse
|
|
2515
|
+
* @example {
|
|
2516
|
+
* "request_id": "5158de19-10b5-4deb-9d87-a86c1dec3460",
|
|
2517
|
+
* "task_group_id": "97241626-8ff4-4550-9938-5909bd221869",
|
|
2518
|
+
* "endpoint_id": "116f1b48-0aab-4228-92f0-021c2ab14b5e",
|
|
2519
|
+
* "tasks": {
|
|
2520
|
+
* "ff960aba-fa23-43d5-9cbe-3f4f91a066e1": [
|
|
2521
|
+
* "89bde6c3-85e9-4834-b0e8-5cb51955eaf5",
|
|
2522
|
+
* "1e900b37-7a80-424b-aeac-56dd2860f59a",
|
|
2523
|
+
* "9f12a732-3aa6-4878-9d58-b290837ab096"
|
|
2524
|
+
* ],
|
|
2525
|
+
* "0a98fd06-edbd-11ed-abcd-0d705ebb4c49": [
|
|
2526
|
+
* "022151bf-7b2d-4240-b4d0-9ac5b7077314",
|
|
2527
|
+
* "1f6f5f1e-15b0-4916-85ff-471511bd35d6"
|
|
2528
|
+
* ]
|
|
2529
|
+
* }
|
|
2530
|
+
* }
|
|
2531
|
+
*/
|
|
2532
|
+
funcx_web_service__schemas__v3__tasks__BatchSubmitResponse: {
|
|
2533
|
+
/**
|
|
2534
|
+
* Request Id
|
|
2535
|
+
* @description A unique string to identify the request; currently this is mainly to aid debugging efforts — such as if a user needs to verify an interaction with Globus Support — and has no automated API hookup or use elsewhere in the Compute ecosystem
|
|
2536
|
+
*/
|
|
2537
|
+
request_id: string;
|
|
2538
|
+
/**
|
|
2539
|
+
* Task Group Id
|
|
2540
|
+
* Format: uuid
|
|
2541
|
+
* @description The Task Group identifier to which the submitted tasks were associated
|
|
2542
|
+
*/
|
|
2543
|
+
task_group_id: string;
|
|
2544
|
+
/**
|
|
2545
|
+
* Endpoint Id
|
|
2546
|
+
* Format: uuid
|
|
2547
|
+
* @description The endpoint to which the request's tasks were sent for invocation
|
|
2548
|
+
*/
|
|
2549
|
+
endpoint_id: string;
|
|
2550
|
+
/**
|
|
2551
|
+
* Tasks
|
|
2552
|
+
* @description The task identifiers, grouped by the identifier of the function IDs that will execute them. Note that the order of the identifiers within each list exactly matches the order of serialized arguments in the request.
|
|
2553
|
+
*/
|
|
2554
|
+
tasks: {
|
|
2555
|
+
[key: string]: string[];
|
|
2556
|
+
};
|
|
2557
|
+
};
|
|
2558
|
+
};
|
|
2559
|
+
responses: never;
|
|
2560
|
+
parameters: never;
|
|
2561
|
+
requestBodies: never;
|
|
2562
|
+
headers: never;
|
|
2563
|
+
pathItems: never;
|
|
2564
|
+
}
|
|
2565
|
+
export type $defs = Record<string, never>;
|
|
2566
|
+
export interface operations {
|
|
2567
|
+
get_version_v2_version_get: {
|
|
2568
|
+
parameters: {
|
|
2569
|
+
query?: {
|
|
2570
|
+
/** @description Service to get version for */
|
|
2571
|
+
service?: components["schemas"]["VersionService"];
|
|
2572
|
+
};
|
|
2573
|
+
header?: never;
|
|
2574
|
+
path?: never;
|
|
2575
|
+
cookie?: never;
|
|
2576
|
+
};
|
|
2577
|
+
requestBody?: never;
|
|
2578
|
+
responses: {
|
|
2579
|
+
/** @description Successful Response */
|
|
2580
|
+
200: {
|
|
2581
|
+
headers: {
|
|
2582
|
+
[name: string]: unknown;
|
|
2583
|
+
};
|
|
2584
|
+
content: {
|
|
2585
|
+
"application/json": string | components["schemas"]["FuncxVersionResponse"];
|
|
2586
|
+
};
|
|
2587
|
+
};
|
|
2588
|
+
/** @description Validation Error */
|
|
2589
|
+
422: {
|
|
2590
|
+
headers: {
|
|
2591
|
+
[name: string]: unknown;
|
|
2592
|
+
};
|
|
2593
|
+
content: {
|
|
2594
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2595
|
+
};
|
|
2596
|
+
};
|
|
2597
|
+
};
|
|
2598
|
+
};
|
|
2599
|
+
get_version_v2_version_head: {
|
|
2600
|
+
parameters: {
|
|
2601
|
+
query?: {
|
|
2602
|
+
/** @description Service to get version for */
|
|
2603
|
+
service?: components["schemas"]["VersionService"];
|
|
2604
|
+
};
|
|
2605
|
+
header?: never;
|
|
2606
|
+
path?: never;
|
|
2607
|
+
cookie?: never;
|
|
2608
|
+
};
|
|
2609
|
+
requestBody?: never;
|
|
2610
|
+
responses: {
|
|
2611
|
+
/** @description Successful Response */
|
|
2612
|
+
200: {
|
|
2613
|
+
headers: {
|
|
2614
|
+
[name: string]: unknown;
|
|
2615
|
+
};
|
|
2616
|
+
content: {
|
|
2617
|
+
"application/json": unknown;
|
|
2618
|
+
};
|
|
2619
|
+
};
|
|
2620
|
+
/** @description Validation Error */
|
|
2621
|
+
422: {
|
|
2622
|
+
headers: {
|
|
2623
|
+
[name: string]: unknown;
|
|
2624
|
+
};
|
|
2625
|
+
content: {
|
|
2626
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2627
|
+
};
|
|
2628
|
+
};
|
|
2629
|
+
};
|
|
2630
|
+
};
|
|
2631
|
+
check_authentication_v2_authenticate_get: {
|
|
2632
|
+
parameters: {
|
|
2633
|
+
query?: never;
|
|
2634
|
+
header?: never;
|
|
2635
|
+
path?: never;
|
|
2636
|
+
cookie?: never;
|
|
2637
|
+
};
|
|
2638
|
+
requestBody?: never;
|
|
2639
|
+
responses: {
|
|
2640
|
+
/** @description Successful Response */
|
|
2641
|
+
200: {
|
|
2642
|
+
headers: {
|
|
2643
|
+
[name: string]: unknown;
|
|
2644
|
+
};
|
|
2645
|
+
content: {
|
|
2646
|
+
"application/json": string;
|
|
2647
|
+
};
|
|
2648
|
+
};
|
|
2649
|
+
};
|
|
2650
|
+
};
|
|
2651
|
+
get_funcx_stats_v2_stats_get: {
|
|
2652
|
+
parameters: {
|
|
2653
|
+
query?: never;
|
|
2654
|
+
header?: never;
|
|
2655
|
+
path?: never;
|
|
2656
|
+
cookie?: never;
|
|
2657
|
+
};
|
|
2658
|
+
requestBody?: never;
|
|
2659
|
+
responses: {
|
|
2660
|
+
/** @description Successful Response */
|
|
2661
|
+
200: {
|
|
2662
|
+
headers: {
|
|
2663
|
+
[name: string]: unknown;
|
|
2664
|
+
};
|
|
2665
|
+
content: {
|
|
2666
|
+
"application/json": components["schemas"]["FuncxStatsResponse"];
|
|
2667
|
+
};
|
|
2668
|
+
};
|
|
2669
|
+
};
|
|
2670
|
+
};
|
|
2671
|
+
get_user_specific_result_amqp_url_v2_get_amqp_result_connection_url_get: {
|
|
2672
|
+
parameters: {
|
|
2673
|
+
query?: never;
|
|
2674
|
+
header?: never;
|
|
2675
|
+
path?: never;
|
|
2676
|
+
cookie?: never;
|
|
2677
|
+
};
|
|
2678
|
+
requestBody?: never;
|
|
2679
|
+
responses: {
|
|
2680
|
+
/** @description Successful Response */
|
|
2681
|
+
200: {
|
|
2682
|
+
headers: {
|
|
2683
|
+
[name: string]: unknown;
|
|
2684
|
+
};
|
|
2685
|
+
content: {
|
|
2686
|
+
"application/json": components["schemas"]["ResultAmqpUrlResponse"];
|
|
2687
|
+
};
|
|
2688
|
+
};
|
|
2689
|
+
};
|
|
2690
|
+
};
|
|
2691
|
+
get_batch_status_v2_batch_status_post: {
|
|
2692
|
+
parameters: {
|
|
2693
|
+
query?: never;
|
|
2694
|
+
header?: never;
|
|
2695
|
+
path?: never;
|
|
2696
|
+
cookie?: never;
|
|
2697
|
+
};
|
|
2698
|
+
requestBody: {
|
|
2699
|
+
content: {
|
|
2700
|
+
"application/json": components["schemas"]["BatchStatusRequest"];
|
|
2701
|
+
};
|
|
2702
|
+
};
|
|
2703
|
+
responses: {
|
|
2704
|
+
/** @description Successful Response */
|
|
2705
|
+
200: {
|
|
2706
|
+
headers: {
|
|
2707
|
+
[name: string]: unknown;
|
|
2708
|
+
};
|
|
2709
|
+
content: {
|
|
2710
|
+
"application/json": components["schemas"]["BatchStatusResponse"];
|
|
2711
|
+
};
|
|
2712
|
+
};
|
|
2713
|
+
/** @description Validation Error */
|
|
2714
|
+
422: {
|
|
2715
|
+
headers: {
|
|
2716
|
+
[name: string]: unknown;
|
|
2717
|
+
};
|
|
2718
|
+
content: {
|
|
2719
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2720
|
+
};
|
|
2721
|
+
};
|
|
2722
|
+
};
|
|
2723
|
+
};
|
|
2724
|
+
submit_batch_v2_submit_post: {
|
|
2725
|
+
parameters: {
|
|
2726
|
+
query?: never;
|
|
2727
|
+
header: {
|
|
2728
|
+
"content-length": number;
|
|
2729
|
+
};
|
|
2730
|
+
path?: never;
|
|
2731
|
+
cookie?: never;
|
|
2732
|
+
};
|
|
2733
|
+
requestBody: {
|
|
2734
|
+
content: {
|
|
2735
|
+
"application/json": components["schemas"]["funcx_web_service__schemas__v2__task__BatchSubmitRequest"];
|
|
2736
|
+
};
|
|
2737
|
+
};
|
|
2738
|
+
responses: {
|
|
2739
|
+
/** @description Successful Response */
|
|
2740
|
+
200: {
|
|
2741
|
+
headers: {
|
|
2742
|
+
[name: string]: unknown;
|
|
2743
|
+
};
|
|
2744
|
+
content: {
|
|
2745
|
+
"application/json": components["schemas"]["funcx_web_service__schemas__v2__task__BatchSubmitResponse"];
|
|
2746
|
+
};
|
|
2747
|
+
};
|
|
2748
|
+
/** @description Validation Error */
|
|
2749
|
+
422: {
|
|
2750
|
+
headers: {
|
|
2751
|
+
[name: string]: unknown;
|
|
2752
|
+
};
|
|
2753
|
+
content: {
|
|
2754
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2755
|
+
};
|
|
2756
|
+
};
|
|
2757
|
+
};
|
|
2758
|
+
};
|
|
2759
|
+
register_container_v2_containers_post: {
|
|
2760
|
+
parameters: {
|
|
2761
|
+
query?: never;
|
|
2762
|
+
header?: never;
|
|
2763
|
+
path?: never;
|
|
2764
|
+
cookie?: never;
|
|
2765
|
+
};
|
|
2766
|
+
requestBody: {
|
|
2767
|
+
content: {
|
|
2768
|
+
"application/json": components["schemas"]["ContainerRegisterRequest"];
|
|
2769
|
+
};
|
|
2770
|
+
};
|
|
2771
|
+
responses: {
|
|
2772
|
+
/** @description Successful Response */
|
|
2773
|
+
200: {
|
|
2774
|
+
headers: {
|
|
2775
|
+
[name: string]: unknown;
|
|
2776
|
+
};
|
|
2777
|
+
content: {
|
|
2778
|
+
"application/json": components["schemas"]["ContainerRegisterResponse"];
|
|
2779
|
+
};
|
|
2780
|
+
};
|
|
2781
|
+
/** @description Validation Error */
|
|
2782
|
+
422: {
|
|
2783
|
+
headers: {
|
|
2784
|
+
[name: string]: unknown;
|
|
2785
|
+
};
|
|
2786
|
+
content: {
|
|
2787
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2788
|
+
};
|
|
2789
|
+
};
|
|
2790
|
+
};
|
|
2791
|
+
};
|
|
2792
|
+
build_container_v2_containers_build_post: {
|
|
2793
|
+
parameters: {
|
|
2794
|
+
query?: never;
|
|
2795
|
+
header?: never;
|
|
2796
|
+
path?: never;
|
|
2797
|
+
cookie?: never;
|
|
2798
|
+
};
|
|
2799
|
+
requestBody: {
|
|
2800
|
+
content: {
|
|
2801
|
+
"application/json": components["schemas"]["ContainerBuildRequest"];
|
|
2802
|
+
};
|
|
2803
|
+
};
|
|
2804
|
+
responses: {
|
|
2805
|
+
/** @description Successful Response */
|
|
2806
|
+
200: {
|
|
2807
|
+
headers: {
|
|
2808
|
+
[name: string]: unknown;
|
|
2809
|
+
};
|
|
2810
|
+
content: {
|
|
2811
|
+
"application/json": components["schemas"]["ContainerBuildResponse"];
|
|
2812
|
+
};
|
|
2813
|
+
};
|
|
2814
|
+
/** @description Validation Error */
|
|
2815
|
+
422: {
|
|
2816
|
+
headers: {
|
|
2817
|
+
[name: string]: unknown;
|
|
2818
|
+
};
|
|
2819
|
+
content: {
|
|
2820
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2821
|
+
};
|
|
2822
|
+
};
|
|
2823
|
+
};
|
|
2824
|
+
};
|
|
2825
|
+
get_container_build_status_v2_containers_build__container_uuid__get: {
|
|
2826
|
+
parameters: {
|
|
2827
|
+
query?: never;
|
|
2828
|
+
header?: never;
|
|
2829
|
+
path: {
|
|
2830
|
+
/** @description Container UUID */
|
|
2831
|
+
container_uuid: string;
|
|
2832
|
+
};
|
|
2833
|
+
cookie?: never;
|
|
2834
|
+
};
|
|
2835
|
+
requestBody?: never;
|
|
2836
|
+
responses: {
|
|
2837
|
+
/** @description Successful Response */
|
|
2838
|
+
200: {
|
|
2839
|
+
headers: {
|
|
2840
|
+
[name: string]: unknown;
|
|
2841
|
+
};
|
|
2842
|
+
content: {
|
|
2843
|
+
"application/json": components["schemas"]["ContainerBuildStatusResponse"];
|
|
2844
|
+
};
|
|
2845
|
+
};
|
|
2846
|
+
/** @description Validation Error */
|
|
2847
|
+
422: {
|
|
2848
|
+
headers: {
|
|
2849
|
+
[name: string]: unknown;
|
|
2850
|
+
};
|
|
2851
|
+
content: {
|
|
2852
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2853
|
+
};
|
|
2854
|
+
};
|
|
2855
|
+
};
|
|
2856
|
+
};
|
|
2857
|
+
get_container_status_v2_containers__container_uuid___container_type__get: {
|
|
2858
|
+
parameters: {
|
|
2859
|
+
query?: never;
|
|
2860
|
+
header?: never;
|
|
2861
|
+
path: {
|
|
2862
|
+
/** @description Container UUID */
|
|
2863
|
+
container_uuid: string;
|
|
2864
|
+
/** @description Type of containers to return (Docker, Singularity) */
|
|
2865
|
+
container_type: string;
|
|
2866
|
+
};
|
|
2867
|
+
cookie?: never;
|
|
2868
|
+
};
|
|
2869
|
+
requestBody?: never;
|
|
2870
|
+
responses: {
|
|
2871
|
+
/** @description Successful Response */
|
|
2872
|
+
200: {
|
|
2873
|
+
headers: {
|
|
2874
|
+
[name: string]: unknown;
|
|
2875
|
+
};
|
|
2876
|
+
content: {
|
|
2877
|
+
"application/json": components["schemas"]["ContainerStatusResponse"];
|
|
2878
|
+
};
|
|
2879
|
+
};
|
|
2880
|
+
/** @description Validation Error */
|
|
2881
|
+
422: {
|
|
2882
|
+
headers: {
|
|
2883
|
+
[name: string]: unknown;
|
|
2884
|
+
};
|
|
2885
|
+
content: {
|
|
2886
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2887
|
+
};
|
|
2888
|
+
};
|
|
2889
|
+
};
|
|
2890
|
+
};
|
|
2891
|
+
get_endpoints_v2_endpoints_get: {
|
|
2892
|
+
parameters: {
|
|
2893
|
+
query?: {
|
|
2894
|
+
/** @description Role of user in relation to desired endpoints */
|
|
2895
|
+
role?: "owner" | "any";
|
|
2896
|
+
};
|
|
2897
|
+
header?: never;
|
|
2898
|
+
path?: never;
|
|
2899
|
+
cookie?: never;
|
|
2900
|
+
};
|
|
2901
|
+
requestBody?: never;
|
|
2902
|
+
responses: {
|
|
2903
|
+
/** @description Successful Response */
|
|
2904
|
+
200: {
|
|
2905
|
+
headers: {
|
|
2906
|
+
[name: string]: unknown;
|
|
2907
|
+
};
|
|
2908
|
+
content: {
|
|
2909
|
+
"application/json": components["schemas"]["EndpointListResponseEntry"][];
|
|
2910
|
+
};
|
|
2911
|
+
};
|
|
2912
|
+
/** @description Validation Error */
|
|
2913
|
+
422: {
|
|
2914
|
+
headers: {
|
|
2915
|
+
[name: string]: unknown;
|
|
2916
|
+
};
|
|
2917
|
+
content: {
|
|
2918
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2919
|
+
};
|
|
2920
|
+
};
|
|
2921
|
+
};
|
|
2922
|
+
};
|
|
2923
|
+
register_endpoint_v2_endpoints_post: {
|
|
2924
|
+
parameters: {
|
|
2925
|
+
query?: never;
|
|
2926
|
+
header: {
|
|
2927
|
+
"user-agent": string;
|
|
2928
|
+
"x-forwarded-for"?: string;
|
|
2929
|
+
"remote-addr"?: string;
|
|
2930
|
+
};
|
|
2931
|
+
path?: never;
|
|
2932
|
+
cookie?: never;
|
|
2933
|
+
};
|
|
2934
|
+
requestBody: {
|
|
2935
|
+
content: {
|
|
2936
|
+
"application/json": components["schemas"]["funcx_web_service__schemas__v2__endpoint__EndpointRegisterRequest"];
|
|
2937
|
+
};
|
|
2938
|
+
};
|
|
2939
|
+
responses: {
|
|
2940
|
+
/** @description Successful Response */
|
|
2941
|
+
200: {
|
|
2942
|
+
headers: {
|
|
2943
|
+
[name: string]: unknown;
|
|
2944
|
+
};
|
|
2945
|
+
content: {
|
|
2946
|
+
"application/json": components["schemas"]["EndpointConfig"] | components["schemas"]["MultiUserEndpointConfig"];
|
|
2947
|
+
};
|
|
2948
|
+
};
|
|
2949
|
+
/** @description Validation Error */
|
|
2950
|
+
422: {
|
|
2951
|
+
headers: {
|
|
2952
|
+
[name: string]: unknown;
|
|
2953
|
+
};
|
|
2954
|
+
content: {
|
|
2955
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2956
|
+
};
|
|
2957
|
+
};
|
|
2958
|
+
};
|
|
2959
|
+
};
|
|
2960
|
+
get_endpoint_v2_endpoints__endpoint_uuid__get: {
|
|
2961
|
+
parameters: {
|
|
2962
|
+
query?: never;
|
|
2963
|
+
header?: never;
|
|
2964
|
+
path: {
|
|
2965
|
+
/** @description Endpoint UUID */
|
|
2966
|
+
endpoint_uuid: string;
|
|
2967
|
+
};
|
|
2968
|
+
cookie?: never;
|
|
2969
|
+
};
|
|
2970
|
+
requestBody?: never;
|
|
2971
|
+
responses: {
|
|
2972
|
+
/** @description Successful Response */
|
|
2973
|
+
200: {
|
|
2974
|
+
headers: {
|
|
2975
|
+
[name: string]: unknown;
|
|
2976
|
+
};
|
|
2977
|
+
content: {
|
|
2978
|
+
"application/json": components["schemas"]["Endpoint"];
|
|
2979
|
+
};
|
|
2980
|
+
};
|
|
2981
|
+
/** @description Validation Error */
|
|
2982
|
+
422: {
|
|
2983
|
+
headers: {
|
|
2984
|
+
[name: string]: unknown;
|
|
2985
|
+
};
|
|
2986
|
+
content: {
|
|
2987
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2988
|
+
};
|
|
2989
|
+
};
|
|
2990
|
+
};
|
|
2991
|
+
};
|
|
2992
|
+
delete_endpoint_v2_endpoints__endpoint_uuid__delete: {
|
|
2993
|
+
parameters: {
|
|
2994
|
+
query?: never;
|
|
2995
|
+
header?: never;
|
|
2996
|
+
path: {
|
|
2997
|
+
/** @description Endpoint UUID */
|
|
2998
|
+
endpoint_uuid: string;
|
|
2999
|
+
};
|
|
3000
|
+
cookie?: never;
|
|
3001
|
+
};
|
|
3002
|
+
requestBody?: never;
|
|
3003
|
+
responses: {
|
|
3004
|
+
/** @description Successful Response */
|
|
3005
|
+
200: {
|
|
3006
|
+
headers: {
|
|
3007
|
+
[name: string]: unknown;
|
|
3008
|
+
};
|
|
3009
|
+
content: {
|
|
3010
|
+
"application/json": components["schemas"]["EndpointDeleteResponse"];
|
|
3011
|
+
};
|
|
3012
|
+
};
|
|
3013
|
+
/** @description Validation Error */
|
|
3014
|
+
422: {
|
|
3015
|
+
headers: {
|
|
3016
|
+
[name: string]: unknown;
|
|
3017
|
+
};
|
|
3018
|
+
content: {
|
|
3019
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
3020
|
+
};
|
|
3021
|
+
};
|
|
3022
|
+
};
|
|
3023
|
+
};
|
|
3024
|
+
get_endpoint_status_v2_endpoints__endpoint_uuid__status_get: {
|
|
3025
|
+
parameters: {
|
|
3026
|
+
query?: never;
|
|
3027
|
+
header?: never;
|
|
3028
|
+
path: {
|
|
3029
|
+
/** @description Endpoint UUID */
|
|
3030
|
+
endpoint_uuid: string;
|
|
3031
|
+
};
|
|
3032
|
+
cookie?: never;
|
|
3033
|
+
};
|
|
3034
|
+
requestBody?: never;
|
|
3035
|
+
responses: {
|
|
3036
|
+
/** @description Successful Response */
|
|
3037
|
+
200: {
|
|
3038
|
+
headers: {
|
|
3039
|
+
[name: string]: unknown;
|
|
3040
|
+
};
|
|
3041
|
+
content: {
|
|
3042
|
+
"application/json": components["schemas"]["EndpointStatusResponse"];
|
|
3043
|
+
};
|
|
3044
|
+
};
|
|
3045
|
+
/** @description Validation Error */
|
|
3046
|
+
422: {
|
|
3047
|
+
headers: {
|
|
3048
|
+
[name: string]: unknown;
|
|
3049
|
+
};
|
|
3050
|
+
content: {
|
|
3051
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
3052
|
+
};
|
|
3053
|
+
};
|
|
3054
|
+
};
|
|
3055
|
+
};
|
|
3056
|
+
lock_endpoint_v2_endpoints__endpoint_uuid__lock_post: {
|
|
3057
|
+
parameters: {
|
|
3058
|
+
query?: never;
|
|
3059
|
+
header?: never;
|
|
3060
|
+
path: {
|
|
3061
|
+
/** @description Endpoint UUID */
|
|
3062
|
+
endpoint_uuid: string;
|
|
3063
|
+
};
|
|
3064
|
+
cookie?: never;
|
|
3065
|
+
};
|
|
3066
|
+
requestBody?: never;
|
|
3067
|
+
responses: {
|
|
3068
|
+
/** @description Successful Response */
|
|
3069
|
+
200: {
|
|
3070
|
+
headers: {
|
|
3071
|
+
[name: string]: unknown;
|
|
3072
|
+
};
|
|
3073
|
+
content: {
|
|
3074
|
+
"application/json": components["schemas"]["funcx_web_service__schemas__v2__endpoint__EndpointLockResponse"];
|
|
3075
|
+
};
|
|
3076
|
+
};
|
|
3077
|
+
/** @description Validation Error */
|
|
3078
|
+
422: {
|
|
3079
|
+
headers: {
|
|
3080
|
+
[name: string]: unknown;
|
|
3081
|
+
};
|
|
3082
|
+
content: {
|
|
3083
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
3084
|
+
};
|
|
3085
|
+
};
|
|
3086
|
+
};
|
|
3087
|
+
};
|
|
3088
|
+
get_function_v2_functions__function_uuid__get: {
|
|
3089
|
+
parameters: {
|
|
3090
|
+
query?: never;
|
|
3091
|
+
header?: never;
|
|
3092
|
+
path: {
|
|
3093
|
+
/** @description Function UUID */
|
|
3094
|
+
function_uuid: string;
|
|
3095
|
+
};
|
|
3096
|
+
cookie?: never;
|
|
3097
|
+
};
|
|
3098
|
+
requestBody?: never;
|
|
3099
|
+
responses: {
|
|
3100
|
+
/** @description Successful Response */
|
|
3101
|
+
200: {
|
|
3102
|
+
headers: {
|
|
3103
|
+
[name: string]: unknown;
|
|
3104
|
+
};
|
|
3105
|
+
content: {
|
|
3106
|
+
"application/json": components["schemas"]["Function"];
|
|
3107
|
+
};
|
|
3108
|
+
};
|
|
3109
|
+
/** @description Validation Error */
|
|
3110
|
+
422: {
|
|
3111
|
+
headers: {
|
|
3112
|
+
[name: string]: unknown;
|
|
3113
|
+
};
|
|
3114
|
+
content: {
|
|
3115
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
3116
|
+
};
|
|
3117
|
+
};
|
|
3118
|
+
};
|
|
3119
|
+
};
|
|
3120
|
+
delete_function_v2_functions__function_uuid__delete: {
|
|
3121
|
+
parameters: {
|
|
3122
|
+
query?: never;
|
|
3123
|
+
header?: never;
|
|
3124
|
+
path: {
|
|
3125
|
+
/** @description Function UUID */
|
|
3126
|
+
function_uuid: string;
|
|
3127
|
+
};
|
|
3128
|
+
cookie?: never;
|
|
3129
|
+
};
|
|
3130
|
+
requestBody?: never;
|
|
3131
|
+
responses: {
|
|
3132
|
+
/** @description Successful Response */
|
|
3133
|
+
200: {
|
|
3134
|
+
headers: {
|
|
3135
|
+
[name: string]: unknown;
|
|
3136
|
+
};
|
|
3137
|
+
content: {
|
|
3138
|
+
"application/json": components["schemas"]["DeleteFunctionResponse"];
|
|
3139
|
+
};
|
|
3140
|
+
};
|
|
3141
|
+
/** @description Validation Error */
|
|
3142
|
+
422: {
|
|
3143
|
+
headers: {
|
|
3144
|
+
[name: string]: unknown;
|
|
3145
|
+
};
|
|
3146
|
+
content: {
|
|
3147
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
3148
|
+
};
|
|
3149
|
+
};
|
|
3150
|
+
};
|
|
3151
|
+
};
|
|
3152
|
+
register_function_v2_functions_post: {
|
|
3153
|
+
parameters: {
|
|
3154
|
+
query?: never;
|
|
3155
|
+
header: {
|
|
3156
|
+
"user-agent": string;
|
|
3157
|
+
};
|
|
3158
|
+
path?: never;
|
|
3159
|
+
cookie?: never;
|
|
3160
|
+
};
|
|
3161
|
+
requestBody: {
|
|
3162
|
+
content: {
|
|
3163
|
+
"application/json": components["schemas"]["funcx_web_service__schemas__v2__function__RegisterFunctionRequest"];
|
|
3164
|
+
};
|
|
3165
|
+
};
|
|
3166
|
+
responses: {
|
|
3167
|
+
/** @description Successful Response */
|
|
3168
|
+
200: {
|
|
3169
|
+
headers: {
|
|
3170
|
+
[name: string]: unknown;
|
|
3171
|
+
};
|
|
3172
|
+
content: {
|
|
3173
|
+
"application/json": components["schemas"]["RegisterFunctionResponse"];
|
|
3174
|
+
};
|
|
3175
|
+
};
|
|
3176
|
+
/** @description Validation Error */
|
|
3177
|
+
422: {
|
|
3178
|
+
headers: {
|
|
3179
|
+
[name: string]: unknown;
|
|
3180
|
+
};
|
|
3181
|
+
content: {
|
|
3182
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
3183
|
+
};
|
|
3184
|
+
};
|
|
3185
|
+
};
|
|
3186
|
+
};
|
|
3187
|
+
get_task_status_and_result_v2_tasks__task_uuid__get: {
|
|
3188
|
+
parameters: {
|
|
3189
|
+
query?: never;
|
|
3190
|
+
header?: never;
|
|
3191
|
+
path: {
|
|
3192
|
+
/** @description Task UUID */
|
|
3193
|
+
task_uuid: string;
|
|
3194
|
+
};
|
|
3195
|
+
cookie?: never;
|
|
3196
|
+
};
|
|
3197
|
+
requestBody?: never;
|
|
3198
|
+
responses: {
|
|
3199
|
+
/** @description Successful Response */
|
|
3200
|
+
200: {
|
|
3201
|
+
headers: {
|
|
3202
|
+
[name: string]: unknown;
|
|
3203
|
+
};
|
|
3204
|
+
content: {
|
|
3205
|
+
"application/json": components["schemas"]["TaskStatusResponse"];
|
|
3206
|
+
};
|
|
3207
|
+
};
|
|
3208
|
+
/** @description Validation Error */
|
|
3209
|
+
422: {
|
|
3210
|
+
headers: {
|
|
3211
|
+
[name: string]: unknown;
|
|
3212
|
+
};
|
|
3213
|
+
content: {
|
|
3214
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
3215
|
+
};
|
|
3216
|
+
};
|
|
3217
|
+
};
|
|
3218
|
+
};
|
|
3219
|
+
get_task_group_tasks_v2_taskgroup__task_group_uuid__get: {
|
|
3220
|
+
parameters: {
|
|
3221
|
+
query?: never;
|
|
3222
|
+
header?: never;
|
|
3223
|
+
path: {
|
|
3224
|
+
/** @description Task Group UUID */
|
|
3225
|
+
task_group_uuid: string;
|
|
3226
|
+
};
|
|
3227
|
+
cookie?: never;
|
|
3228
|
+
};
|
|
3229
|
+
requestBody?: never;
|
|
3230
|
+
responses: {
|
|
3231
|
+
/** @description Successful Response */
|
|
3232
|
+
200: {
|
|
3233
|
+
headers: {
|
|
3234
|
+
[name: string]: unknown;
|
|
3235
|
+
};
|
|
3236
|
+
content: {
|
|
3237
|
+
"application/json": components["schemas"]["TaskGroupResponse"];
|
|
3238
|
+
};
|
|
3239
|
+
};
|
|
3240
|
+
/** @description Validation Error */
|
|
3241
|
+
422: {
|
|
3242
|
+
headers: {
|
|
3243
|
+
[name: string]: unknown;
|
|
3244
|
+
};
|
|
3245
|
+
content: {
|
|
3246
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
3247
|
+
};
|
|
3248
|
+
};
|
|
3249
|
+
};
|
|
3250
|
+
};
|
|
3251
|
+
register_endpoint_v3_endpoints_post: {
|
|
3252
|
+
parameters: {
|
|
3253
|
+
query?: never;
|
|
3254
|
+
header: {
|
|
3255
|
+
"user-agent": string;
|
|
3256
|
+
"x-forwarded-for"?: string;
|
|
3257
|
+
"remote-addr"?: string;
|
|
3258
|
+
};
|
|
3259
|
+
path?: never;
|
|
3260
|
+
cookie?: never;
|
|
3261
|
+
};
|
|
3262
|
+
requestBody: {
|
|
3263
|
+
content: {
|
|
3264
|
+
"application/json": components["schemas"]["funcx_web_service__schemas__v3__endpoints__EndpointRegisterRequest"];
|
|
3265
|
+
};
|
|
3266
|
+
};
|
|
3267
|
+
responses: {
|
|
3268
|
+
/** @description Successful Response */
|
|
3269
|
+
200: {
|
|
3270
|
+
headers: {
|
|
3271
|
+
[name: string]: unknown;
|
|
3272
|
+
};
|
|
3273
|
+
content: {
|
|
3274
|
+
"application/json": components["schemas"]["EndpointRegisterResponse"] | components["schemas"]["MultiUserEndpointRegisterResponse"];
|
|
3275
|
+
};
|
|
3276
|
+
};
|
|
3277
|
+
/** @description Bad Request */
|
|
3278
|
+
400: {
|
|
3279
|
+
headers: {
|
|
3280
|
+
[name: string]: unknown;
|
|
3281
|
+
};
|
|
3282
|
+
content: {
|
|
3283
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3284
|
+
};
|
|
3285
|
+
};
|
|
3286
|
+
/** @description Unauthorized */
|
|
3287
|
+
401: {
|
|
3288
|
+
headers: {
|
|
3289
|
+
[name: string]: unknown;
|
|
3290
|
+
};
|
|
3291
|
+
content: {
|
|
3292
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3293
|
+
};
|
|
3294
|
+
};
|
|
3295
|
+
/** @description Not Found */
|
|
3296
|
+
404: {
|
|
3297
|
+
headers: {
|
|
3298
|
+
[name: string]: unknown;
|
|
3299
|
+
};
|
|
3300
|
+
content: {
|
|
3301
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3302
|
+
};
|
|
3303
|
+
};
|
|
3304
|
+
/** @description Unprocessable Entity */
|
|
3305
|
+
422: {
|
|
3306
|
+
headers: {
|
|
3307
|
+
[name: string]: unknown;
|
|
3308
|
+
};
|
|
3309
|
+
content: {
|
|
3310
|
+
"application/json": components["schemas"]["ValidationErrorResponse"];
|
|
3311
|
+
};
|
|
3312
|
+
};
|
|
3313
|
+
/** @description Locked */
|
|
3314
|
+
423: {
|
|
3315
|
+
headers: {
|
|
3316
|
+
[name: string]: unknown;
|
|
3317
|
+
};
|
|
3318
|
+
content: {
|
|
3319
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3320
|
+
};
|
|
3321
|
+
};
|
|
3322
|
+
/** @description Internal Server Error */
|
|
3323
|
+
500: {
|
|
3324
|
+
headers: {
|
|
3325
|
+
[name: string]: unknown;
|
|
3326
|
+
};
|
|
3327
|
+
content: {
|
|
3328
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3329
|
+
};
|
|
3330
|
+
};
|
|
3331
|
+
};
|
|
3332
|
+
};
|
|
3333
|
+
update_endpoint_v3_endpoints__endpoint_uuid__put: {
|
|
3334
|
+
parameters: {
|
|
3335
|
+
query?: never;
|
|
3336
|
+
header: {
|
|
3337
|
+
"user-agent": string;
|
|
3338
|
+
"x-forwarded-for"?: string;
|
|
3339
|
+
"remote-addr"?: string;
|
|
3340
|
+
};
|
|
3341
|
+
path: {
|
|
3342
|
+
endpoint_uuid: string;
|
|
3343
|
+
};
|
|
3344
|
+
cookie?: never;
|
|
3345
|
+
};
|
|
3346
|
+
requestBody: {
|
|
3347
|
+
content: {
|
|
3348
|
+
"application/json": components["schemas"]["funcx_web_service__schemas__v3__endpoints__EndpointRegisterRequest"];
|
|
3349
|
+
};
|
|
3350
|
+
};
|
|
3351
|
+
responses: {
|
|
3352
|
+
/** @description Successful Response */
|
|
3353
|
+
200: {
|
|
3354
|
+
headers: {
|
|
3355
|
+
[name: string]: unknown;
|
|
3356
|
+
};
|
|
3357
|
+
content: {
|
|
3358
|
+
"application/json": components["schemas"]["EndpointRegisterResponse"] | components["schemas"]["MultiUserEndpointRegisterResponse"];
|
|
3359
|
+
};
|
|
3360
|
+
};
|
|
3361
|
+
/** @description Bad Request */
|
|
3362
|
+
400: {
|
|
3363
|
+
headers: {
|
|
3364
|
+
[name: string]: unknown;
|
|
3365
|
+
};
|
|
3366
|
+
content: {
|
|
3367
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3368
|
+
};
|
|
3369
|
+
};
|
|
3370
|
+
/** @description Unauthorized */
|
|
3371
|
+
401: {
|
|
3372
|
+
headers: {
|
|
3373
|
+
[name: string]: unknown;
|
|
3374
|
+
};
|
|
3375
|
+
content: {
|
|
3376
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3377
|
+
};
|
|
3378
|
+
};
|
|
3379
|
+
/** @description Forbidden */
|
|
3380
|
+
403: {
|
|
3381
|
+
headers: {
|
|
3382
|
+
[name: string]: unknown;
|
|
3383
|
+
};
|
|
3384
|
+
content: {
|
|
3385
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3386
|
+
};
|
|
3387
|
+
};
|
|
3388
|
+
/** @description Not Found */
|
|
3389
|
+
404: {
|
|
3390
|
+
headers: {
|
|
3391
|
+
[name: string]: unknown;
|
|
3392
|
+
};
|
|
3393
|
+
content: {
|
|
3394
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3395
|
+
};
|
|
3396
|
+
};
|
|
3397
|
+
/** @description Conflict */
|
|
3398
|
+
409: {
|
|
3399
|
+
headers: {
|
|
3400
|
+
[name: string]: unknown;
|
|
3401
|
+
};
|
|
3402
|
+
content: {
|
|
3403
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3404
|
+
};
|
|
3405
|
+
};
|
|
3406
|
+
/** @description Unprocessable Entity */
|
|
3407
|
+
422: {
|
|
3408
|
+
headers: {
|
|
3409
|
+
[name: string]: unknown;
|
|
3410
|
+
};
|
|
3411
|
+
content: {
|
|
3412
|
+
"application/json": components["schemas"]["ValidationErrorResponse"];
|
|
3413
|
+
};
|
|
3414
|
+
};
|
|
3415
|
+
/** @description Locked */
|
|
3416
|
+
423: {
|
|
3417
|
+
headers: {
|
|
3418
|
+
[name: string]: unknown;
|
|
3419
|
+
};
|
|
3420
|
+
content: {
|
|
3421
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3422
|
+
};
|
|
3423
|
+
};
|
|
3424
|
+
/** @description Internal Server Error */
|
|
3425
|
+
500: {
|
|
3426
|
+
headers: {
|
|
3427
|
+
[name: string]: unknown;
|
|
3428
|
+
};
|
|
3429
|
+
content: {
|
|
3430
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3431
|
+
};
|
|
3432
|
+
};
|
|
3433
|
+
};
|
|
3434
|
+
};
|
|
3435
|
+
lock_endpoint_v3_endpoints__endpoint_uuid__lock_post: {
|
|
3436
|
+
parameters: {
|
|
3437
|
+
query?: never;
|
|
3438
|
+
header?: never;
|
|
3439
|
+
path: {
|
|
3440
|
+
/** @description Endpoint UUID */
|
|
3441
|
+
endpoint_uuid: string;
|
|
3442
|
+
};
|
|
3443
|
+
cookie?: never;
|
|
3444
|
+
};
|
|
3445
|
+
requestBody?: never;
|
|
3446
|
+
responses: {
|
|
3447
|
+
/** @description Successful Response */
|
|
3448
|
+
200: {
|
|
3449
|
+
headers: {
|
|
3450
|
+
[name: string]: unknown;
|
|
3451
|
+
};
|
|
3452
|
+
content: {
|
|
3453
|
+
"application/json": components["schemas"]["funcx_web_service__schemas__v3__endpoints__EndpointLockResponse"];
|
|
3454
|
+
};
|
|
3455
|
+
};
|
|
3456
|
+
/** @description Unauthorized */
|
|
3457
|
+
401: {
|
|
3458
|
+
headers: {
|
|
3459
|
+
[name: string]: unknown;
|
|
3460
|
+
};
|
|
3461
|
+
content: {
|
|
3462
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3463
|
+
};
|
|
3464
|
+
};
|
|
3465
|
+
/** @description Forbidden */
|
|
3466
|
+
403: {
|
|
3467
|
+
headers: {
|
|
3468
|
+
[name: string]: unknown;
|
|
3469
|
+
};
|
|
3470
|
+
content: {
|
|
3471
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3472
|
+
};
|
|
3473
|
+
};
|
|
3474
|
+
/** @description Not Found */
|
|
3475
|
+
404: {
|
|
3476
|
+
headers: {
|
|
3477
|
+
[name: string]: unknown;
|
|
3478
|
+
};
|
|
3479
|
+
content: {
|
|
3480
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3481
|
+
};
|
|
3482
|
+
};
|
|
3483
|
+
/** @description Unprocessable Entity */
|
|
3484
|
+
422: {
|
|
3485
|
+
headers: {
|
|
3486
|
+
[name: string]: unknown;
|
|
3487
|
+
};
|
|
3488
|
+
content: {
|
|
3489
|
+
"application/json": components["schemas"]["ValidationErrorResponse"];
|
|
3490
|
+
};
|
|
3491
|
+
};
|
|
3492
|
+
/** @description Internal Server Error */
|
|
3493
|
+
500: {
|
|
3494
|
+
headers: {
|
|
3495
|
+
[name: string]: unknown;
|
|
3496
|
+
};
|
|
3497
|
+
content: {
|
|
3498
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3499
|
+
};
|
|
3500
|
+
};
|
|
3501
|
+
};
|
|
3502
|
+
};
|
|
3503
|
+
submit_batch_v3_endpoints__endpoint_uuid__submit_post: {
|
|
3504
|
+
parameters: {
|
|
3505
|
+
query?: never;
|
|
3506
|
+
header: {
|
|
3507
|
+
"user-agent": string;
|
|
3508
|
+
"content-length": number;
|
|
3509
|
+
};
|
|
3510
|
+
path: {
|
|
3511
|
+
/** @description Endpoint UUID */
|
|
3512
|
+
endpoint_uuid: string;
|
|
3513
|
+
};
|
|
3514
|
+
cookie?: never;
|
|
3515
|
+
};
|
|
3516
|
+
requestBody: {
|
|
3517
|
+
content: {
|
|
3518
|
+
"application/json": components["schemas"]["funcx_web_service__schemas__v3__tasks__BatchSubmitRequest"];
|
|
3519
|
+
};
|
|
3520
|
+
};
|
|
3521
|
+
responses: {
|
|
3522
|
+
/** @description Successful Response */
|
|
3523
|
+
200: {
|
|
3524
|
+
headers: {
|
|
3525
|
+
[name: string]: unknown;
|
|
3526
|
+
};
|
|
3527
|
+
content: {
|
|
3528
|
+
"application/json": components["schemas"]["funcx_web_service__schemas__v3__tasks__BatchSubmitResponse"];
|
|
3529
|
+
};
|
|
3530
|
+
};
|
|
3531
|
+
/** @description Unauthorized */
|
|
3532
|
+
401: {
|
|
3533
|
+
headers: {
|
|
3534
|
+
[name: string]: unknown;
|
|
3535
|
+
};
|
|
3536
|
+
content: {
|
|
3537
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3538
|
+
};
|
|
3539
|
+
};
|
|
3540
|
+
/** @description Forbidden */
|
|
3541
|
+
403: {
|
|
3542
|
+
headers: {
|
|
3543
|
+
[name: string]: unknown;
|
|
3544
|
+
};
|
|
3545
|
+
content: {
|
|
3546
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3547
|
+
};
|
|
3548
|
+
};
|
|
3549
|
+
/** @description Not Found */
|
|
3550
|
+
404: {
|
|
3551
|
+
headers: {
|
|
3552
|
+
[name: string]: unknown;
|
|
3553
|
+
};
|
|
3554
|
+
content: {
|
|
3555
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3556
|
+
};
|
|
3557
|
+
};
|
|
3558
|
+
/** @description Request Entity Too Large */
|
|
3559
|
+
413: {
|
|
3560
|
+
headers: {
|
|
3561
|
+
[name: string]: unknown;
|
|
3562
|
+
};
|
|
3563
|
+
content: {
|
|
3564
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3565
|
+
};
|
|
3566
|
+
};
|
|
3567
|
+
/** @description Unprocessable Entity */
|
|
3568
|
+
422: {
|
|
3569
|
+
headers: {
|
|
3570
|
+
[name: string]: unknown;
|
|
3571
|
+
};
|
|
3572
|
+
content: {
|
|
3573
|
+
"application/json": components["schemas"]["ValidationErrorResponse"];
|
|
3574
|
+
};
|
|
3575
|
+
};
|
|
3576
|
+
/** @description Internal Server Error */
|
|
3577
|
+
500: {
|
|
3578
|
+
headers: {
|
|
3579
|
+
[name: string]: unknown;
|
|
3580
|
+
};
|
|
3581
|
+
content: {
|
|
3582
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3583
|
+
};
|
|
3584
|
+
};
|
|
3585
|
+
};
|
|
3586
|
+
};
|
|
3587
|
+
get_endpoint_allowlist_v3_endpoints__endpoint_uuid__allowed_functions_get: {
|
|
3588
|
+
parameters: {
|
|
3589
|
+
query?: never;
|
|
3590
|
+
header?: never;
|
|
3591
|
+
path: {
|
|
3592
|
+
/** @description Endpoint UUID */
|
|
3593
|
+
endpoint_uuid: string;
|
|
3594
|
+
};
|
|
3595
|
+
cookie?: never;
|
|
3596
|
+
};
|
|
3597
|
+
requestBody?: never;
|
|
3598
|
+
responses: {
|
|
3599
|
+
/** @description Successful Response */
|
|
3600
|
+
200: {
|
|
3601
|
+
headers: {
|
|
3602
|
+
[name: string]: unknown;
|
|
3603
|
+
};
|
|
3604
|
+
content: {
|
|
3605
|
+
"application/json": components["schemas"]["AllowedFunctionsResponse"];
|
|
3606
|
+
};
|
|
3607
|
+
};
|
|
3608
|
+
/** @description Validation Error */
|
|
3609
|
+
422: {
|
|
3610
|
+
headers: {
|
|
3611
|
+
[name: string]: unknown;
|
|
3612
|
+
};
|
|
3613
|
+
content: {
|
|
3614
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
3615
|
+
};
|
|
3616
|
+
};
|
|
3617
|
+
};
|
|
3618
|
+
};
|
|
3619
|
+
get_endpoint_console_info_v3_endpoints__endpoint_uuid__console_get: {
|
|
3620
|
+
parameters: {
|
|
3621
|
+
query?: {
|
|
3622
|
+
/**
|
|
3623
|
+
* @description Provide the UUID of a specific user endpoint to return.
|
|
3624
|
+
* @example 99418dfd-2bcd-473c-a0b5-3aaedd855d82
|
|
3625
|
+
*/
|
|
3626
|
+
user_endpoint_id?: string;
|
|
3627
|
+
/**
|
|
3628
|
+
* @description Comma separated list of user endpoint fields to include in the response. If left blank, all fields except 'config' are included. Invalid field names will result in a 400 error.
|
|
3629
|
+
* @example user_endpoint_id,node_info,config
|
|
3630
|
+
*/
|
|
3631
|
+
include_fields?: string;
|
|
3632
|
+
};
|
|
3633
|
+
header?: never;
|
|
3634
|
+
path: {
|
|
3635
|
+
/** @description Multi-user endpoint UUID */
|
|
3636
|
+
endpoint_uuid: string;
|
|
3637
|
+
};
|
|
3638
|
+
cookie?: never;
|
|
3639
|
+
};
|
|
3640
|
+
requestBody?: never;
|
|
3641
|
+
responses: {
|
|
3642
|
+
/** @description Successful Response */
|
|
3643
|
+
200: {
|
|
3644
|
+
headers: {
|
|
3645
|
+
[name: string]: unknown;
|
|
3646
|
+
};
|
|
3647
|
+
content: {
|
|
3648
|
+
"application/json": components["schemas"]["ConsoleResponse"];
|
|
3649
|
+
};
|
|
3650
|
+
};
|
|
3651
|
+
/** @description Bad Request */
|
|
3652
|
+
400: {
|
|
3653
|
+
headers: {
|
|
3654
|
+
[name: string]: unknown;
|
|
3655
|
+
};
|
|
3656
|
+
content: {
|
|
3657
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3658
|
+
};
|
|
3659
|
+
};
|
|
3660
|
+
/** @description Unauthorized */
|
|
3661
|
+
401: {
|
|
3662
|
+
headers: {
|
|
3663
|
+
[name: string]: unknown;
|
|
3664
|
+
};
|
|
3665
|
+
content: {
|
|
3666
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3667
|
+
};
|
|
3668
|
+
};
|
|
3669
|
+
/** @description Forbidden */
|
|
3670
|
+
403: {
|
|
3671
|
+
headers: {
|
|
3672
|
+
[name: string]: unknown;
|
|
3673
|
+
};
|
|
3674
|
+
content: {
|
|
3675
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3676
|
+
};
|
|
3677
|
+
};
|
|
3678
|
+
/** @description Not Found */
|
|
3679
|
+
404: {
|
|
3680
|
+
headers: {
|
|
3681
|
+
[name: string]: unknown;
|
|
3682
|
+
};
|
|
3683
|
+
content: {
|
|
3684
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3685
|
+
};
|
|
3686
|
+
};
|
|
3687
|
+
/** @description Unprocessable Entity */
|
|
3688
|
+
422: {
|
|
3689
|
+
headers: {
|
|
3690
|
+
[name: string]: unknown;
|
|
3691
|
+
};
|
|
3692
|
+
content: {
|
|
3693
|
+
"application/json": components["schemas"]["ValidationErrorResponse"];
|
|
3694
|
+
};
|
|
3695
|
+
};
|
|
3696
|
+
/** @description Internal Server Error */
|
|
3697
|
+
500: {
|
|
3698
|
+
headers: {
|
|
3699
|
+
[name: string]: unknown;
|
|
3700
|
+
};
|
|
3701
|
+
content: {
|
|
3702
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3703
|
+
};
|
|
3704
|
+
};
|
|
3705
|
+
};
|
|
3706
|
+
};
|
|
3707
|
+
register_function_v3_functions_post: {
|
|
3708
|
+
parameters: {
|
|
3709
|
+
query?: never;
|
|
3710
|
+
header?: never;
|
|
3711
|
+
path?: never;
|
|
3712
|
+
cookie?: never;
|
|
3713
|
+
};
|
|
3714
|
+
requestBody: {
|
|
3715
|
+
content: {
|
|
3716
|
+
"application/json": components["schemas"]["funcx_web_service__schemas__v3__function__RegisterFunctionRequest"];
|
|
3717
|
+
};
|
|
3718
|
+
};
|
|
3719
|
+
responses: {
|
|
3720
|
+
/** @description Successful Response */
|
|
3721
|
+
200: {
|
|
3722
|
+
headers: {
|
|
3723
|
+
[name: string]: unknown;
|
|
3724
|
+
};
|
|
3725
|
+
content: {
|
|
3726
|
+
"application/json": components["schemas"]["RegisterFunctionResponse"];
|
|
3727
|
+
};
|
|
3728
|
+
};
|
|
3729
|
+
/** @description Unauthorized */
|
|
3730
|
+
401: {
|
|
3731
|
+
headers: {
|
|
3732
|
+
[name: string]: unknown;
|
|
3733
|
+
};
|
|
3734
|
+
content: {
|
|
3735
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3736
|
+
};
|
|
3737
|
+
};
|
|
3738
|
+
/** @description Request Entity Too Large */
|
|
3739
|
+
413: {
|
|
3740
|
+
headers: {
|
|
3741
|
+
[name: string]: unknown;
|
|
3742
|
+
};
|
|
3743
|
+
content: {
|
|
3744
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3745
|
+
};
|
|
3746
|
+
};
|
|
3747
|
+
/** @description Unprocessable Entity */
|
|
3748
|
+
422: {
|
|
3749
|
+
headers: {
|
|
3750
|
+
[name: string]: unknown;
|
|
3751
|
+
};
|
|
3752
|
+
content: {
|
|
3753
|
+
"application/json": components["schemas"]["ErrorResponse"] | components["schemas"]["ValidationErrorResponse"];
|
|
3754
|
+
};
|
|
3755
|
+
};
|
|
3756
|
+
};
|
|
3757
|
+
};
|
|
3758
|
+
}
|
|
3759
|
+
//# sourceMappingURL=compute.d.ts.map
|