@squonk/data-manager-client 1.2.8 → 1.2.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (114) hide show
  1. package/README.md +1 -1
  2. package/accounting/accounting.cjs +51 -8
  3. package/accounting/accounting.cjs.map +1 -1
  4. package/accounting/accounting.d.cts +61 -10
  5. package/accounting/accounting.d.ts +61 -10
  6. package/accounting/accounting.js +49 -6
  7. package/accounting/accounting.js.map +1 -1
  8. package/admin/admin.cjs +67 -24
  9. package/admin/admin.cjs.map +1 -1
  10. package/admin/admin.d.cts +75 -24
  11. package/admin/admin.d.ts +75 -24
  12. package/admin/admin.js +56 -13
  13. package/admin/admin.js.map +1 -1
  14. package/application/application.cjs +35 -6
  15. package/application/application.cjs.map +1 -1
  16. package/application/application.d.cts +42 -8
  17. package/application/application.d.ts +42 -8
  18. package/application/application.js +34 -5
  19. package/application/application.js.map +1 -1
  20. package/{chunk-UKA7G3OB.js → chunk-EBOQPVLG.js} +2 -2
  21. package/{chunk-UKA7G3OB.js.map → chunk-EBOQPVLG.js.map} +1 -1
  22. package/{chunk-J22A7LHX.cjs → chunk-TKLTUR4R.cjs} +2 -2
  23. package/chunk-TKLTUR4R.cjs.map +1 -0
  24. package/configuration/configuration.cjs +19 -4
  25. package/configuration/configuration.cjs.map +1 -1
  26. package/configuration/configuration.d.cts +23 -6
  27. package/configuration/configuration.d.ts +23 -6
  28. package/configuration/configuration.js +19 -4
  29. package/configuration/configuration.js.map +1 -1
  30. package/dataset/dataset.cjs +93 -22
  31. package/dataset/dataset.cjs.map +1 -1
  32. package/dataset/dataset.d.cts +105 -20
  33. package/dataset/dataset.d.ts +105 -20
  34. package/dataset/dataset.js +83 -12
  35. package/dataset/dataset.js.map +1 -1
  36. package/exchange-rate/exchange-rate.cjs +71 -14
  37. package/exchange-rate/exchange-rate.cjs.map +1 -1
  38. package/exchange-rate/exchange-rate.d.cts +83 -15
  39. package/exchange-rate/exchange-rate.d.ts +83 -15
  40. package/exchange-rate/exchange-rate.js +65 -8
  41. package/exchange-rate/exchange-rate.js.map +1 -1
  42. package/file-and-path/file-and-path.cjs +45 -16
  43. package/file-and-path/file-and-path.cjs.map +1 -1
  44. package/file-and-path/file-and-path.d.cts +48 -14
  45. package/file-and-path/file-and-path.d.ts +48 -14
  46. package/file-and-path/file-and-path.js +39 -10
  47. package/file-and-path/file-and-path.js.map +1 -1
  48. package/index.cjs +9 -2
  49. package/index.cjs.map +1 -1
  50. package/index.d.cts +2033 -2
  51. package/index.d.ts +2033 -2
  52. package/index.js +8 -1
  53. package/index.js.map +1 -1
  54. package/instance/instance.cjs +45 -16
  55. package/instance/instance.cjs.map +1 -1
  56. package/instance/instance.d.cts +48 -14
  57. package/instance/instance.d.ts +48 -14
  58. package/instance/instance.js +38 -9
  59. package/instance/instance.js.map +1 -1
  60. package/job/job.cjs +51 -8
  61. package/job/job.cjs.map +1 -1
  62. package/job/job.d.cts +61 -10
  63. package/job/job.d.ts +61 -10
  64. package/job/job.js +49 -6
  65. package/job/job.js.map +1 -1
  66. package/metadata/metadata.cjs +39 -10
  67. package/metadata/metadata.cjs.map +1 -1
  68. package/metadata/metadata.d.cts +45 -11
  69. package/metadata/metadata.d.ts +45 -11
  70. package/metadata/metadata.js +36 -7
  71. package/metadata/metadata.js.map +1 -1
  72. package/package.json +11 -11
  73. package/project/project.cjs +83 -26
  74. package/project/project.cjs.map +1 -1
  75. package/project/project.d.cts +89 -21
  76. package/project/project.d.ts +89 -21
  77. package/project/project.js +71 -14
  78. package/project/project.js.map +1 -1
  79. package/src/accounting/accounting.ts +136 -22
  80. package/src/admin/admin.ts +148 -50
  81. package/src/application/application.ts +93 -18
  82. package/src/configuration/configuration.ts +50 -14
  83. package/src/custom-instance.ts +3 -4
  84. package/src/data-manager-api.schemas.ts +59 -33
  85. package/src/dataset/dataset.ts +233 -45
  86. package/src/exchange-rate/exchange-rate.ts +185 -32
  87. package/src/file-and-path/file-and-path.ts +98 -33
  88. package/src/instance/instance.ts +98 -33
  89. package/src/job/job.ts +138 -22
  90. package/src/metadata/metadata.ts +97 -24
  91. package/src/project/project.ts +191 -50
  92. package/src/task/task.ts +96 -21
  93. package/src/type/type.ts +50 -14
  94. package/src/user/user.ts +137 -25
  95. package/task/task.cjs +37 -8
  96. package/task/task.cjs.map +1 -1
  97. package/task/task.d.cts +44 -10
  98. package/task/task.d.ts +44 -10
  99. package/task/task.js +35 -6
  100. package/task/task.js.map +1 -1
  101. package/type/type.cjs +19 -4
  102. package/type/type.cjs.map +1 -1
  103. package/type/type.d.cts +23 -6
  104. package/type/type.d.ts +23 -6
  105. package/type/type.js +19 -4
  106. package/type/type.js.map +1 -1
  107. package/user/user.cjs +53 -10
  108. package/user/user.cjs.map +1 -1
  109. package/user/user.d.cts +63 -12
  110. package/user/user.d.ts +63 -12
  111. package/user/user.js +49 -6
  112. package/user/user.js.map +1 -1
  113. package/chunk-J22A7LHX.cjs.map +0 -1
  114. package/custom-instance-37ed2460.d.ts +0 -2014
@@ -1,2014 +0,0 @@
1
- import * as axios from 'axios';
2
- import { AxiosRequestConfig, AxiosError } from 'axios';
3
-
4
- /**
5
- * Generated by orval v6.20.0 🍺
6
- * Do not edit manually.
7
- * Dataset Manager API
8
- * The Dataset Manager API service.
9
-
10
- A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
11
-
12
- * OpenAPI spec version: 1.2
13
- */
14
- type AdminDeleteJobManifestParams = {
15
- /**
16
- * Purge unreferenced Jobs
17
- */
18
- purge?: QPurgeParameter;
19
- };
20
- type AdminGetUsersParams = {
21
- /**
22
- * Maximum days a user has been idle (has not used the API). If you specify `2` and it's Monday then users who have not used the API since Saturday will be returned.
23
-
24
- */
25
- idle_days?: QIdleDaysParameter;
26
- /**
27
- * Minimum days a user has been active (has used the API). If you specify `2` and it's Monday then users who have used the API on Saturday or later will be returned.
28
-
29
- */
30
- active_days?: QActiveDaysParameter;
31
- };
32
- type AdminGetServiceErrorsParams = {
33
- /**
34
- * Set to include acknowledged items
35
-
36
- */
37
- include_acknowleged?: QIncludeAcknowlegedParameter;
38
- };
39
- type GetUserApiLogParams = {
40
- /**
41
- * A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
42
-
43
- */
44
- from?: QFromParameter;
45
- /**
46
- * An until (exclusive) date-time. If provided only API calls made before this will be returned. UTC is assumed if no timezone is provided
47
-
48
- */
49
- until?: QUntilParameter;
50
- };
51
- type GetUserAccountParams = {
52
- /**
53
- * Set, if you're an admin, to call the endpoint without impersonation
54
-
55
- */
56
- do_not_impersonate?: QDoNotImpersonateParameter;
57
- };
58
- type PatchInstanceParams = {
59
- /**
60
- * True to archive the instance
61
- */
62
- archive?: QInstanceArchiveParameter;
63
- };
64
- type GetInstancesParams = {
65
- /**
66
- * A Project identity
67
- */
68
- project_id?: QProjectIdParameter;
69
- };
70
- type GetJobExchangeRatesParams = {
71
- /**
72
- * Set to get current
73
-
74
- */
75
- current?: QCurrentParameter;
76
- };
77
- type GetAllJobExchangeRatesParams = {
78
- /**
79
- * Only return records where the exchange rate is undefined
80
-
81
- */
82
- only_undefined?: QOnlyUndefinedParameter;
83
- };
84
- type GetJobParams = {
85
- /**
86
- * A Project identity
87
- */
88
- project_id?: QProjectIdParameter;
89
- };
90
- type GetJobByVersionParams = {
91
- /**
92
- * The Collection for a Job, i.e. "im-test"
93
-
94
- */
95
- collection: QJobCollectionParameter;
96
- /**
97
- * The Job, i.e. "nop"
98
-
99
- */
100
- job: QJobJobParameter;
101
- /**
102
- * The version of a Job, i.e. "1.0.0"
103
-
104
- */
105
- version: QJobVersionParameter;
106
- /**
107
- * A Project identity
108
- */
109
- project_id?: QProjectIdParameter;
110
- };
111
- type GetJobsParams = {
112
- /**
113
- * A Project identity
114
- */
115
- project_id?: QProjectIdParameter;
116
- };
117
- type GetApplicationExchangeRatesParams = {
118
- /**
119
- * Set to get current
120
-
121
- */
122
- current?: QCurrentParameter;
123
- };
124
- type GetAllApplicationExchangeRatesParams = {
125
- /**
126
- * Only return records where the exchange rate is undefined
127
-
128
- */
129
- only_undefined?: QOnlyUndefinedParameter;
130
- };
131
- type GetTaskParams = {
132
- /**
133
- * Maximum number of events to return. If provided, can be 1 or more.
134
-
135
- */
136
- event_limit?: QEventLimitParameter;
137
- /**
138
- * The ordinal of a previously received event. If set, only events subsequent to the ordinal provided will be returned. Providing a value of 0 will result in retrieving the first and subsequent events.
139
-
140
- */
141
- event_prior_ordinal?: QEventPriorOrdinalParameter;
142
- };
143
- type GetTasksParams = {
144
- /**
145
- * Set true if you want to exclude 'done' tasks, i.e. just see those that are still running.
146
-
147
- */
148
- exclude_done?: QExcludeDoneParameter;
149
- /**
150
- * Set true if you want to exclude Tasks related to object removal.
151
-
152
- */
153
- exclude_removal?: QExcludeRemovalParameter;
154
- /**
155
- * Set to a dot-separated string of purpose enumerations, i.e. `DATASET`, `FILE`, `INSTANCE`, or `PROJECT`. To exclude file and dataset tasks set this field to `FILE.DATASET`
156
-
157
- */
158
- exclude_purpose?: QExcludePurposeParameter;
159
- /**
160
- * A Project identity
161
- */
162
- project_id?: QProjectIdParameter;
163
- /**
164
- * An instance callback context string
165
- */
166
- instance_callback_context?: QInstanceCallbackContextParameter;
167
- };
168
- type DeleteUnmanagedFileParams = {
169
- /**
170
- * A project file.
171
-
172
- */
173
- file: QFileParameter;
174
- /**
175
- * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
176
-
177
- */
178
- path?: QFilePathParameter;
179
- /**
180
- * The Project identity
181
- */
182
- project_id: QFileProjectIdParameter;
183
- };
184
- type GetFilesParams = {
185
- /**
186
- * The Project identity
187
- */
188
- project_id: QFileProjectIdParameter;
189
- /**
190
- * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
191
-
192
- */
193
- path?: QFilePathParameter;
194
- /**
195
- * Whether to include hidden files and directories
196
- */
197
- include_hidden?: QIncludeHiddenParameter;
198
- };
199
- type DeleteDatasetParams = {
200
- /**
201
- * Whether to convert Project managed file instances to unmanaged files
202
-
203
- */
204
- keep_project_files?: QKeepProjectFilesParameter;
205
- };
206
- type GetVersionsParams = {
207
- /**
208
- * Whether to include records that are deleted
209
- */
210
- include_deleted?: QIncludeDeletedParameter;
211
- };
212
- type GetDatasetsParams = {
213
- /**
214
- * Whether to include records that are deleted
215
- */
216
- include_deleted?: QIncludeDeletedParameter;
217
- /**
218
- * Filter the datasets by username
219
-
220
- */
221
- username?: QUsernameParameter;
222
- /**
223
- * Filter the datasets by the supplied mime_type.
224
-
225
- */
226
- dataset_mime_type?: QDatasetMimeTypeParameter;
227
- /**
228
- * Filter the datasets by a comma separated list of owners
229
-
230
- */
231
- owners?: QOwnersParameter;
232
- /**
233
- * Filter the datasets by a comma separated list of editors
234
-
235
- */
236
- editors?: QEditorsParameter;
237
- /**
238
- * JSON string containing a list of label/value pairs for the datasets to be filtered by. If the value is set to null, then only the label is matched. If both the label and value are set, then both are matched. e.g. '{"label1": null, "label2": "value2"}'
239
-
240
- */
241
- labels?: QLabelsParameter;
242
- };
243
- type GetProjectFileWithTokenParams = {
244
- /**
245
- * A token
246
- */
247
- token?: QTokenParameter;
248
- /**
249
- * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
250
-
251
- */
252
- path?: QFilePathParameter;
253
- /**
254
- * A project file.
255
-
256
- */
257
- file: QFileParameter;
258
- };
259
- type GetProjectFileParams = {
260
- /**
261
- * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
262
-
263
- */
264
- path?: QFilePathParameter;
265
- /**
266
- * A project file.
267
-
268
- */
269
- file: QFileParameter;
270
- };
271
- type GetProjectsParams = {
272
- /**
273
- * A Project name
274
- */
275
- project_name?: QProjectNameParameter;
276
- };
277
- type DeletePathParams = {
278
- /**
279
- * The Project identity
280
- */
281
- project_id: QFileProjectIdParameter;
282
- /**
283
- * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
284
-
285
- */
286
- path?: QFilePathParameter;
287
- };
288
- type CreatePathParams = {
289
- /**
290
- * The Project identity
291
- */
292
- project_id: QFileProjectIdParameter;
293
- /**
294
- * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
295
-
296
- */
297
- path?: QFilePathParameter;
298
- };
299
- /**
300
- * Filter the datasets by a comma separated list of editors
301
-
302
- */
303
- type QEditorsParameter = string;
304
- /**
305
- * Purge unreferenced Jobs
306
- */
307
- type QPurgeParameter = boolean;
308
- /**
309
- * Filter the datasets by a comma separated list of owners
310
-
311
- */
312
- type QOwnersParameter = string;
313
- /**
314
- * Filter the datasets by username
315
-
316
- */
317
- type QUsernameParameter = string;
318
- /**
319
- * An until (exclusive) date-time. If provided only API calls made before this will be returned. UTC is assumed if no timezone is provided
320
-
321
- */
322
- type QUntilParameter = string;
323
- /**
324
- * A token
325
- */
326
- type QTokenParameter = string;
327
- /**
328
- * An instance callback context string
329
- */
330
- type QInstanceCallbackContextParameter = string;
331
- /**
332
- * A Project name
333
- */
334
- type QProjectNameParameter = string;
335
- /**
336
- * A Project identity
337
- */
338
- type QProjectIdParameter = string;
339
- /**
340
- * JSON string containing a list of label/value pairs for the datasets to be filtered by. If the value is set to null, then only the label is matched. If both the label and value are set, then both are matched. e.g. '{"label1": null, "label2": "value2"}'
341
-
342
- */
343
- type QLabelsParameter = string;
344
- /**
345
- * Only return records where the exchange rate is undefined
346
-
347
- */
348
- type QOnlyUndefinedParameter = boolean;
349
- /**
350
- * Whether to convert Project managed file instances to unmanaged files
351
-
352
- */
353
- type QKeepProjectFilesParameter = boolean;
354
- /**
355
- * The version of a Job, i.e. "1.0.0"
356
-
357
- */
358
- type QJobVersionParameter = string;
359
- /**
360
- * The Job, i.e. "nop"
361
-
362
- */
363
- type QJobJobParameter = string;
364
- /**
365
- * A Job identity
366
-
367
- */
368
- type QJobIdParameter = number;
369
- /**
370
- * The Collection for a Job, i.e. "im-test"
371
-
372
- */
373
- type QJobCollectionParameter = string;
374
- /**
375
- * True to archive the instance
376
- */
377
- type QInstanceArchiveParameter = boolean;
378
- /**
379
- * Whether to include hidden files and directories
380
- */
381
- type QIncludeHiddenParameter = boolean;
382
- /**
383
- * Whether to include records that are deleted
384
- */
385
- type QIncludeDeletedParameter = boolean;
386
- /**
387
- * Set to include acknowledged items
388
-
389
- */
390
- type QIncludeAcknowlegedParameter = boolean;
391
- /**
392
- * A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
393
-
394
- */
395
- type QFromParameter = string;
396
- /**
397
- * The Project identity
398
- */
399
- type QFileProjectIdParameter = string;
400
- /**
401
- * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
402
-
403
- */
404
- type QFilePathParameter = string;
405
- /**
406
- * A project file.
407
-
408
- */
409
- type QFileParameter = string;
410
- /**
411
- * Minimum days a user has been active (has used the API). If you specify `2` and it's Monday then users who have used the API on Saturday or later will be returned.
412
-
413
- */
414
- type QActiveDaysParameter = number;
415
- /**
416
- * Maximum days a user has been idle (has not used the API). If you specify `2` and it's Monday then users who have not used the API since Saturday will be returned.
417
-
418
- */
419
- type QIdleDaysParameter = number;
420
- /**
421
- * Set to a dot-separated string of purpose enumerations, i.e. `DATASET`, `FILE`, `INSTANCE`, or `PROJECT`. To exclude file and dataset tasks set this field to `FILE.DATASET`
422
-
423
- */
424
- type QExcludePurposeParameter = string;
425
- /**
426
- * Set true if you want to exclude Tasks related to object removal.
427
-
428
- */
429
- type QExcludeRemovalParameter = boolean;
430
- /**
431
- * Set true if you want to exclude 'done' tasks, i.e. just see those that are still running.
432
-
433
- */
434
- type QExcludeDoneParameter = boolean;
435
- /**
436
- * The ordinal of a previously received event. If set, only events subsequent to the ordinal provided will be returned. Providing a value of 0 will result in retrieving the first and subsequent events.
437
-
438
- */
439
- type QEventPriorOrdinalParameter = number;
440
- /**
441
- * Maximum number of events to return. If provided, can be 1 or more.
442
-
443
- */
444
- type QEventLimitParameter = number;
445
- /**
446
- * Filter the datasets by the supplied mime_type.
447
-
448
- */
449
- type QDatasetMimeTypeParameter = string;
450
- /**
451
- * Set, if you're an admin, to call the endpoint without impersonation
452
-
453
- */
454
- type QDoNotImpersonateParameter = boolean;
455
- /**
456
- * Set to get current
457
-
458
- */
459
- type QCurrentParameter = boolean;
460
- /**
461
- * An Application identity
462
-
463
- */
464
- type QApplicationIdParameter = string;
465
- type UserPatchBodyBody = {
466
- /** If set to a message the user account is suspended, with the user receiving this message when they try and use the API. A suspended user account can be restored by setting the message to `/restore`
467
- */
468
- suspend_message?: string;
469
- };
470
- type UserAccountPatchBodyBody = {
471
- /** For `admin` accounts, if set the user account is able to read anything, i.e. `GET` API calls (i.e. endpoints that do not change the Data Manager state) behave as though the caller is acting as *everyone*. An `admin` user would set ths parameter in order to browse the system, and then switch to `impersonate` mode in order to change things as the chosen user
472
- */
473
- become_admin?: boolean;
474
- /** For `admin` accounts, if set API calls behave as though the caller is the user being impersonated. To stop impersonating set this to an empty string. To set impersonation to anything other than an empty string you must also set `become_admin`
475
- */
476
- impersonate?: string;
477
- /** If set the user account becomes private, if provided but false the user account becomes public. Public Users show up in user searches
478
- */
479
- private?: boolean;
480
- /** For `admin` accounts, if this is set the account for the user being impersonated is patched, rather then the user's own account. To use this you must have a value for `impersonate`
481
- */
482
- use_impersonation?: boolean;
483
- };
484
- type ProjectPostBodyBody = {
485
- name: string;
486
- /** Whether the project is private. You may not be permitted to make the project private, that will depend on the project product you're using to create the project
487
- */
488
- private?: boolean;
489
- /** The Data Manager *Tier Product ID* you're using to create the Project
490
- */
491
- tier_product_id: string;
492
- };
493
- type ProjectPatchBodyBody = {
494
- /** The new name of the ptojct
495
- */
496
- name?: string;
497
- private?: boolean;
498
- };
499
- type ProjectFilePutBodyBody = {
500
- /** An alternative filename to use for the uploaded File
501
- */
502
- as_filename?: string;
503
- file: Blob;
504
- /** The Project path of the file.
505
- */
506
- path?: string;
507
- };
508
- type ExchangeRatePutBodyBody = {
509
- /** A brief comment relating to the new rate
510
- */
511
- comment?: string;
512
- /** A decimal value used as the new Exchange Rate. Application _raw_ **costs** are multiplied by this value to covert costs to **coins**. A string is used to avoid rounding errors. Internally the value is treated as a Python Decimal.
513
- */
514
- rate: string;
515
- };
516
- type JobManifestPutBodyBody = {
517
- /** Optional URL header values (a JSON string) */
518
- header?: string;
519
- /** Optional URL parameter values (a JSON string) */
520
- params?: string;
521
- /** The URL of the Job Manifest */
522
- url: string;
523
- };
524
- type InstancePostBodyBody = {
525
- /** A supported application. Applications instances are managed using pre-deployed Kubernetes **Operators**. The application ID is a combination of the operator _plural_ and _group_.
526
-
527
- Application IDs currently supported include `datamanagerjobs.squonk.it` and `jupyternotebooks.squonk.it`
528
- */
529
- application_id: string;
530
- /** A supported application version to launch.
531
-
532
- This property is **Deprecated**. It is currently ignored will be removed in a future release
533
- */
534
- application_version?: string;
535
- /** The name to use for the instance
536
- */
537
- as_name: string;
538
- /** Used in conjunction with the `callback_url` any value provided here will be passed back in the message payload that's delivered to the callback URL. It can be used by the recipient to provide a context that's meaningful
539
- */
540
- callback_context?: string;
541
- /** An optional 22-character **sortuuid** callback token that is supplied by the remote service. If not provided the user can use `generate_callback_token` to have one generated and returned in the response.
542
-
543
- See the Python module's `shortuuid.get_alphabet()` for the full list of permitted characters
544
- */
545
- callback_token?: string;
546
- /** A URL the DM will use to PUT job progress messages as the requested instance runs. Used, at the moment, for Job execution
547
- */
548
- callback_url?: string;
549
- /** A debug value that may be used by the instance.
550
-
551
- For Data Manager **Job** applications setting this to anything other zero ('0') prevents the Job's Pod from being deleted automatically, allowing a developer to inspect the Pod's log for example.
552
-
553
- The behaviour of **Application** instances using this property is undefined. It will depend on whether the application **CRD** handles the Data Manager debug field.
554
- */
555
- debug?: string;
556
- /** If set a callback token will be provided in the response. The token allows files to be downloaded from the instance project and expires after a pre-configured amount of time after the instance is complete or if the user revokes the token.
557
-
558
- Caution should be taken using this feature. A 3rd party can access the Project's files without authentication, they just need the token and the project identity.
559
-
560
- Tokens should therefore be revoked when they're no longer required
561
- */
562
- generate_callback_token?: boolean;
563
- /** The project to attach
564
- */
565
- project_id: string;
566
- /** The instance specification. A JSON string that's application-specific and controls the application's behaviour.
567
-
568
- When launching a Data Manager **Job** Application you must identify the Job using the properties `collection`, `job` and `version`, e.g. `{"collection":"im-test","job":"nop","version":"1.0.0"}`
569
-
570
- Jobs that offer commands will often advertise a series of **inputs** and **options** where the values can be provided using a **variables** map in the specification. Something like `"variables":{"x":7}`.
571
-
572
- Jobs start in a Job-specific **working directory** but the starting directory for any Job can be adjusted by defining a `sub_path` to the root specification. For example, if you want the Job to start in the path `foo/bar` (inside the Job's built-in working directory) you can add `"sub_path":"foo/bar"` to the specification. You can only use a sub-path for a Job if the Job defines a working directory and `sub-path` cannot begin or end with a path separator (`/`).
573
-
574
- Applications also support `variables`. The Jupyter notebook application supports the definition of the notebook `"image"`, `"cpu"` and `"memory"`. A full Jupyter notebook specification might be `{"variables":{"image":"Tensorflow 2.9","cpu":2,"memory":"4Gi"}}`, where `memory` is limited to `Gi` as a suffix.
575
- */
576
- specification?: string;
577
- };
578
- type FilePostBodyBody = {
579
- /** The desired Dataset file type (a MIME type). Whether or not the chosen fileType is supported will depend on the Dataset
580
- */
581
- as_type: string;
582
- /** Whether to compress the Dataset File as it's attached. Compression is achieved using gzip, resulting in a File ending `.gz`. By default the file will be compressed
583
- */
584
- compress?: boolean;
585
- /** The Dataset UUID for the File that you intend to attach
586
- */
587
- dataset_id: string;
588
- /** The Dataset version to attach
589
- */
590
- dataset_version: number;
591
- /** Whether the Dataset File can be modified while in the Project. By default the File cannot be modified
592
- */
593
- immutable?: boolean;
594
- /** A path within the Project to add the File, default is the project root ('/'), the mount-point within the application container. Paths must begin '/'
595
- */
596
- path?: string;
597
- /** The Project UUID you're attaching to
598
- */
599
- project_id: string;
600
- };
601
- type DatasetPutBodyBody = {
602
- /** If provided the File becomes a new version of the Dataset named. If not provided this File becomes the first version of a new Dataset, whose ID is returned to you on success.
603
- */
604
- dataset_id?: string;
605
- /** The MIME type of the Dataset
606
- */
607
- dataset_type: string;
608
- /** The file name of the file in the Project path to load as a new Dataset.
609
- */
610
- file_name: string;
611
- /** Extra variables (text) presented to the Dataset format-support container, which occurs during the upload and database processing stage. The content of the text is Dataset type specific.
612
- */
613
- format_extra_variables?: string;
614
- /** The Project path of the file.
615
- */
616
- path: string;
617
- /** The Project the file belongs to
618
- */
619
- project_id: string;
620
- /** If set the post-format database load action is skipped. This means the dataset is uploaded but its molecules are not entered into the Data Manager database. This can save significant time if you're just experimenting with the dataset and do not need the molecules in the database
621
- */
622
- skip_molecule_load?: boolean;
623
- /** The Organisational Unit you want the Dataset to belong to. If not supplied the Project Unit is used
624
- */
625
- unit_id?: string;
626
- };
627
- type DatasetVersionMetaPostBodyBody = {
628
- /** JSON string containing a list of annotations. The format of the labels should match either the Fields Descriptor or Service Execution annotation formats described in the data-manager-metadata library.
629
- */
630
- annotations?: string;
631
- /** JSON string containing a list of parameter changes to the metadata. Only the description is currently allowed.
632
- */
633
- meta_properties?: string;
634
- };
635
- type DatasetMetaPostBodyBody = {
636
- /** JSON string containing a list of labels. The format of the labels should match the label annotation format described in the data-manager-metadata library.
637
- */
638
- labels?: string;
639
- /** JSON string containing a list of parameter changes to the metadata. Only the description is currently allowed.
640
- */
641
- meta_properties?: string;
642
- };
643
- type DatasetPostBodyBody = {
644
- /** An optional new filename to use for the uploaded Dataset. The Dataset will be stored using this name.
645
- */
646
- as_filename?: string;
647
- dataset_file: Blob;
648
- /** If provided the Dataset becomes a new version of the Dataset named. If not provided this Dataset becomes the first version of a new Dataset, whose ID is returned to you on success.
649
- */
650
- dataset_id?: string;
651
- /** The MIME type of the Dataset. Values like `chemical/x-mdl-sdfile`, `chemical/x-mdl-molfile`, and `chemical/x-pdb` are permitted. See the **\/type** endpoint for a full list of types.
652
- */
653
- dataset_type: string;
654
- /** Extra variables (text) presented to the Dataset format-support container, which occurs during the upload and database processing stage. The content of the text is Dataset type specific.
655
- */
656
- format_extra_variables?: string;
657
- /** If set the post-format database load action is skipped. This means the dataset is uploaded but its molecules are not entered into the Data Manager database. This can save significant time if you're just experimenting with the dataset and do not need the molecules in the database
658
- */
659
- skip_molecule_load?: boolean;
660
- /** The Organisational Unit you want the Dataset to belong to
661
- */
662
- unit_id: string;
663
- };
664
- interface AsAdditionalDataProcessingCharge {
665
- collateral_cpu_hours?: string;
666
- collateral_pod_count?: number;
667
- cost: string;
668
- cost_scale_factor: string;
669
- cost_to_coins_er: string;
670
- error_message?: string;
671
- instance_id: string;
672
- instance_name: string;
673
- job_collection?: string;
674
- job_job?: string;
675
- job_version?: string;
676
- run_time?: string;
677
- started: string;
678
- stopped?: string;
679
- }
680
- interface UserSummary {
681
- /** The user's preferred username
682
- */
683
- username: string;
684
- }
685
- interface UserDetail {
686
- /** For admin accounts, whether the user is acting in an administrative capacity, i.e. acting as everyone
687
- */
688
- become_admin?: boolean;
689
- /** The user's filesystem user uid
690
- */
691
- f_uid?: number;
692
- /** The date and time the user was first seen (an ISO-8601 formatted string in UTC)
693
- */
694
- first_seen?: string;
695
- /** For admin accounts, whether the user is impersonating another user
696
- */
697
- impersonate?: string;
698
- /** The date the user was last seen
699
- */
700
- last_seen_date?: string;
701
- /** Set if the user's account is marked as private. Private accounts do not show up against general queries.
702
- */
703
- private: boolean;
704
- /** True if the account is suspended
705
- */
706
- suspended?: boolean;
707
- /** If the account is suspended this typically displays a reason for suspension
708
- */
709
- suspension_message?: string;
710
- /** The user's preferred username
711
- */
712
- username: string;
713
- }
714
- interface UserAccountDetail {
715
- /** Whether the caller has admin privilege */
716
- caller_has_admin_privilege: boolean;
717
- /** The Data Manager roles the user has */
718
- data_manager_roles: string[];
719
- user: UserDetail;
720
- }
721
- /**
722
- * The Schema type (an object)
723
-
724
- */
725
- type TypeSummaryFormatterOptionsType = typeof TypeSummaryFormatterOptionsType[keyof typeof TypeSummaryFormatterOptionsType];
726
- declare const TypeSummaryFormatterOptionsType: {
727
- readonly object: "object";
728
- };
729
- /**
730
- * If present, contains the formatter_options that can be entered in the format_extra_variables field in the POST /dataset api.
731
-
732
- */
733
- type TypeSummaryFormatterOptions = {
734
- /** Required properties
735
- */
736
- required: string[];
737
- /** The title of the Formatter object
738
- */
739
- title: string;
740
- /** The Schema type (an object)
741
- */
742
- type: TypeSummaryFormatterOptionsType;
743
- [key: string]: any;
744
- };
745
- interface TypeSummary {
746
- /** The file's supported file extensions. Each type is limited to a limited number of extensions. For example, SDF files must have the extension `.sdf` (or `.sdf.gz`).
747
- */
748
- file_extensions: string[];
749
- /** The file's type's format-support container image (if set). Types without a format support image cannot be uploaded, but they might be available for use as destination type when a Dataset is added to a Project.
750
- */
751
- formatter_image?: string;
752
- /** If present, contains the formatter_options that can be entered in the format_extra_variables field in the POST /dataset api.
753
- */
754
- formatter_options?: TypeSummaryFormatterOptions;
755
- /** True if Datasets uploaded using this type's support loading of data into the Data Manager data-base.
756
- */
757
- formatter_supports_db_load?: boolean;
758
- /** The File Type MIME
759
- */
760
- mime: string;
761
- }
762
- /**
763
- * The processing stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
764
-
765
- */
766
- type TaskSummaryProcessingStage = typeof TaskSummaryProcessingStage[keyof typeof TaskSummaryProcessingStage];
767
- declare const TaskSummaryProcessingStage: {
768
- readonly COPYING: "COPYING";
769
- readonly FAILED: "FAILED";
770
- readonly FORMATTING: "FORMATTING";
771
- readonly LOADING: "LOADING";
772
- readonly DELETING: "DELETING";
773
- readonly DONE: "DONE";
774
- };
775
- interface TaskSummary {
776
- /** The date and time the task was created
777
- */
778
- created: string;
779
- /** True if the task has run to completion. If the task finished successfully the `exit_code` will be zero.
780
- */
781
- done: boolean;
782
- /** Present when `done` and zero if the task finished successfully.
783
- */
784
- exit_code?: number;
785
- /** The Task UUID
786
- */
787
- id: string;
788
- /** If a container image is launched by the task the image name is available here
789
- */
790
- image?: string;
791
- /** The processing stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
792
- */
793
- processing_stage?: TaskSummaryProcessingStage;
794
- /** The purpose for the Task. Tasks are responsible for _uploading_ a Dataset, _attaching_ a Dataset as a File to a project or launching an Applications _instance_.
795
- */
796
- purpose: string;
797
- /** The related object ID for the Task purpose. If the purpose relates to a **Dataset** upload the ID will be a Dataset ID.
798
- */
799
- purpose_id: string;
800
- /** The related object version for the Task purpose. This field will only be set if the **purpose** is `DATASET`.
801
- */
802
- purpose_version?: number;
803
- /** True if the Task relates to an object removal, i.e. a DELETE
804
- */
805
- removal?: boolean;
806
- }
807
- /**
808
- * The task state. The typical state sequence is `PENDING`, then `STARTED` and finally `SUCCESS`
809
-
810
- */
811
- type TaskStateState = typeof TaskStateState[keyof typeof TaskStateState];
812
- declare const TaskStateState: {
813
- readonly PENDING: "PENDING";
814
- readonly STARTED: "STARTED";
815
- readonly RETRY: "RETRY";
816
- readonly SUCCESS: "SUCCESS";
817
- readonly FAILURE: "FAILURE";
818
- };
819
- interface TaskState {
820
- /** A short message accompanying the state, generally only found when the state is `FAILURE`
821
- */
822
- message?: string;
823
- /** The task state. The typical state sequence is `PENDING`, then `STARTED` and finally `SUCCESS`
824
- */
825
- state: TaskStateState;
826
- /** The date and time of the state change
827
- */
828
- time: string;
829
- }
830
- interface TaskIdentity {
831
- task_id: string;
832
- }
833
- /**
834
- * The level of the message, a typical logging framework value
835
-
836
- */
837
- type TaskEventLevel = typeof TaskEventLevel[keyof typeof TaskEventLevel];
838
- declare const TaskEventLevel: {
839
- readonly CRITICAL: "CRITICAL";
840
- readonly ERROR: "ERROR";
841
- readonly WARNING: "WARNING";
842
- readonly INFO: "INFO";
843
- readonly DEBUG: "DEBUG";
844
- };
845
- interface TaskEvent {
846
- /** The level of the message, a typical logging framework value
847
- */
848
- level: TaskEventLevel;
849
- /** A short message.
850
- */
851
- message: string;
852
- /** The event sequence number. The first event is always '1'.
853
- */
854
- ordinal: number;
855
- /** The date and time the event was generated
856
- */
857
- time: string;
858
- }
859
- type ServiceErrorSummarySeverity = typeof ServiceErrorSummarySeverity[keyof typeof ServiceErrorSummarySeverity];
860
- declare const ServiceErrorSummarySeverity: {
861
- readonly CRITICAL: "CRITICAL";
862
- readonly ERROR: "ERROR";
863
- readonly WARNING: "WARNING";
864
- };
865
- interface ServiceErrorSummary {
866
- acknowledged: boolean;
867
- acknowledged_at?: string;
868
- acknowledging_user?: string;
869
- created: string;
870
- error_code?: number;
871
- hostname: string;
872
- id: number;
873
- severity: ServiceErrorSummarySeverity;
874
- stack_trace: string;
875
- summary: string;
876
- }
877
- interface ProjectFileDetail {
878
- /** The code obtained from the Account Server
879
- */
880
- authorisation_code?: number;
881
- /** The ProjectFile's Dataset origin
882
- */
883
- dataset_id?: string;
884
- /** The ProjectFile's Dataset origin version
885
- */
886
- dataset_version?: number;
887
- /** The ProjectFile's unique ID
888
- */
889
- file_id: string;
890
- /** The ProjectFile's filename within the Project
891
- */
892
- file_name: string;
893
- /** The ProjectFile's path within the Project volume
894
- */
895
- file_path: string;
896
- /** True if the ProjectFile cannot be modified while in the Project
897
- */
898
- immutable: boolean;
899
- /** The ProjectFile MIME type
900
- */
901
- mime_type: string;
902
- /** The owner of the ProjectFile. This is the user that added the Dataset (as this file) to the Project
903
- */
904
- owner: string;
905
- /** The Project the ProjectFile belongs to
906
- */
907
- project_id?: string;
908
- }
909
- interface ProjectDetail {
910
- created: string;
911
- /** An editor (user_id) of the project */
912
- editors: string[];
913
- /** A list of managed files in the Project
914
- */
915
- files?: ProjectFileDetail[];
916
- /** The project name
917
- */
918
- name: string;
919
- /** An observer (user_id) of the project */
920
- observers: string[];
921
- /** The Account Server Organisation the Project Product Unit belongs to
922
- */
923
- organisation_id?: string;
924
- /** The project (owner) creator
925
- */
926
- owner: string;
927
- /** True if the project is private. Private projects are only visible to the owner and its editors.
928
- */
929
- private: boolean;
930
- /** The Account Server Product the Project belongs to
931
- */
932
- product_id?: string;
933
- /** The project unique reference
934
- */
935
- project_id: string;
936
- /** The approximate size of all the files in the Project volume. This is updated regularly throughout the day and its current size may differ from what is reported here. The smallest billable unit is 1GiB (1,073,741,824 bytes). Therefore a project that contains 32KiB of files is recorded as 1GiB in size */
937
- size: number;
938
- /** The Account Server Unit the Project Product belongs to
939
- */
940
- unit_id?: string;
941
- }
942
- interface JobReplacement {
943
- collection: string;
944
- job: string;
945
- }
946
- /**
947
- * A list of Jobs, collection and job that are either replacing or being replaced
948
-
949
- */
950
- type JobReplacements = JobReplacement[];
951
- interface JobOrderDetail {
952
- options: string[];
953
- }
954
- /**
955
- * The Job command's outputs. The JSONSchema for the command's inputs, essentially the **variables/outputs** block of the Job's JobDefinition.
956
-
957
- */
958
- type JobVariablesOutputs = {
959
- [key: string]: any;
960
- };
961
- /**
962
- * The Job command's options. The JSONSchema for the command's options, essentially the **variables/options** block of the Job's JobDefinition.
963
-
964
- */
965
- type JobVariablesOptions = {
966
- [key: string]: any;
967
- };
968
- /**
969
- * The Job command's inputs. The JSONSchema for the command's inputs, essentially the **variables/inputs** block of the Job's JobDefinition.
970
-
971
- */
972
- type JobVariablesInputs = {
973
- [key: string]: any;
974
- };
975
- interface JobVariables {
976
- /** The Job command's inputs. The JSONSchema for the command's inputs, essentially the **variables/inputs** block of the Job's JobDefinition.
977
- */
978
- inputs?: JobVariablesInputs;
979
- /** The Job command's options. The JSONSchema for the command's options, essentially the **variables/options** block of the Job's JobDefinition.
980
- */
981
- options?: JobVariablesOptions;
982
- /** The Job command's variable ordering declaration. Contains a list of `options` in an ordered list, the order defines the order of presentation of the Job's variables.
983
- */
984
- order?: JobOrderDetail;
985
- /** The Job command's outputs. The JSONSchema for the command's inputs, essentially the **variables/outputs** block of the Job's JobDefinition.
986
- */
987
- outputs?: JobVariablesOutputs;
988
- }
989
- /**
990
- * The optional container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
991
-
992
- */
993
- type JobSummaryImageType = typeof JobSummaryImageType[keyof typeof JobSummaryImageType];
994
- declare const JobSummaryImageType: {
995
- readonly SIMPLE: "SIMPLE";
996
- readonly NEXTFLOW: "NEXTFLOW";
997
- };
998
- interface JobSummary {
999
- /** The Job's category
1000
- */
1001
- category?: string;
1002
- /** The Job namespace
1003
- */
1004
- collection: string;
1005
- /** The description of the job in English
1006
- */
1007
- description?: string;
1008
- /** True if disabled. Disabled Jobs cannot be executed. If disabled a reason will be found in `disabled_reason`
1009
- */
1010
- disabled: boolean;
1011
- /** A reason why the Job has been disabled.
1012
- */
1013
- disabled_reason?: string;
1014
- /** A suggested remedy that accompanies the "disabled_reason". This provides the client with advice on how to avoid the reason that the Job's been disabled, for reasons that can be avoided (not all are).
1015
-
1016
- Where there is no remedy for a given reason the remedy will be "There is no remedy".
1017
- */
1018
- disabled_remedy?: string;
1019
- /** A URL linking to the Job documentation
1020
- */
1021
- doc_url?: string;
1022
- /** The Job's unique ID
1023
- */
1024
- id: number;
1025
- /** The optional container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
1026
- */
1027
- image_type: JobSummaryImageType;
1028
- /** The Job name, unique within a given namespace
1029
- */
1030
- job: string;
1031
- /** The list of keywords assigned to the Job
1032
- */
1033
- keywords?: string[];
1034
- /** A list of Account Server "required_assets" that cannot be found. If assets cannot be found the user will receive a "disabled_reason" that should explain the problem.
1035
- */
1036
- missing_assets?: string[];
1037
- /** The name of the job in English
1038
- */
1039
- name: string;
1040
- replaced_by?: JobReplacements;
1041
- replaces?: JobReplacements;
1042
- /** A list of Account Server assets names required to run the Job. You need access to these assets in order to run the Job
1043
- */
1044
- required_assets: string[];
1045
- /** The Job version
1046
- */
1047
- version: string;
1048
- }
1049
- interface JobManifestDetail {
1050
- /** The Date (and time) the manifest was created
1051
- */
1052
- created: string;
1053
- /** The (admin) user who created the manifest
1054
- */
1055
- creator?: string;
1056
- header?: string;
1057
- /** The Job Manifest record ID */
1058
- id: number;
1059
- /** The number of job definition files loaded during the most recent successful load
1060
- */
1061
- job_definition_files_loaded?: number;
1062
- /** The number of job definitions loaded during the most recent successful load
1063
- */
1064
- job_definitions_loaded?: number;
1065
- /** The status of the time the manifest was last loaded. If the load was successful this will be `SUCCESS` and `last_successful_load` will be the same as `last_load`
1066
- */
1067
- last_load_status: string;
1068
- /** The Date (and time) the manifest was last loaded, successfully or otherwise. If the manifest (or any of the Job definition files it refers to) fails to load the `load_status` should provide some diagnostic feedback
1069
- */
1070
- last_load_time?: string;
1071
- /** The Date (and time) the manifest was last loaded successfully
1072
- */
1073
- last_successful_load_time?: string;
1074
- params?: string;
1075
- url: string;
1076
- }
1077
- interface JobApplication {
1078
- /** The Job's operator ID */
1079
- id: string;
1080
- /** The Job's operator version */
1081
- version: string;
1082
- }
1083
- /**
1084
- * The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1085
- The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
1086
-
1087
- */
1088
- type InstanceSummaryPhase = typeof InstanceSummaryPhase[keyof typeof InstanceSummaryPhase];
1089
- declare const InstanceSummaryPhase: {
1090
- readonly COMPLETED: "COMPLETED";
1091
- readonly CRASH_LOOP_BACKOFF: "CRASH_LOOP_BACKOFF";
1092
- readonly FAILED: "FAILED";
1093
- readonly IMAGE_PULL_BACKOFF: "IMAGE_PULL_BACKOFF";
1094
- readonly PENDING: "PENDING";
1095
- readonly RUNNING: "RUNNING";
1096
- readonly SUCCEEDED: "SUCCEEDED";
1097
- readonly UNKNOWN: "UNKNOWN";
1098
- };
1099
- /**
1100
- * The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
1101
-
1102
- */
1103
- type InstanceSummaryJobImageType = typeof InstanceSummaryJobImageType[keyof typeof InstanceSummaryJobImageType];
1104
- declare const InstanceSummaryJobImageType: {
1105
- readonly SIMPLE: "SIMPLE";
1106
- readonly NEXTFLOW: "NEXTFLOW";
1107
- };
1108
- /**
1109
- * The type of Application, which can be a `job` or an `application`
1110
-
1111
- */
1112
- type InstanceSummaryApplicationType = typeof InstanceSummaryApplicationType[keyof typeof InstanceSummaryApplicationType];
1113
- declare const InstanceSummaryApplicationType: {
1114
- readonly APPLICATION: "APPLICATION";
1115
- readonly JOB: "JOB";
1116
- };
1117
- interface InstanceSummary {
1118
- /** The application ID
1119
- */
1120
- application_id: string;
1121
- /** The User's specification, provided when the application was launched
1122
- */
1123
- application_specification?: string;
1124
- /** The type of Application, which can be a `job` or an `application`
1125
- */
1126
- application_type: InstanceSummaryApplicationType;
1127
- /** The application version
1128
- */
1129
- application_version: string;
1130
- /** True if the instance is archived (protected from automatic deletion)
1131
- */
1132
- archived: boolean;
1133
- /** The code obtained from the Account Server
1134
- */
1135
- authorisation_code?: number;
1136
- /** The current running coin cost of the instance.
1137
- */
1138
- coins?: string;
1139
- /** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes.
1140
- */
1141
- fix_permissions?: boolean;
1142
- /** The application instance ID
1143
- */
1144
- id: string;
1145
- /** If the instance relates to a job, this will be the job collection, as defined in the original collection's job definition.
1146
- */
1147
- job_collection?: string;
1148
- /** The Job definition's unique ID
1149
- */
1150
- job_id?: number;
1151
- /** The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
1152
- */
1153
- job_image_type?: InstanceSummaryJobImageType;
1154
- /** If the instance relates to a job, this will be the job, as defined in the original collection's job definition.
1155
- */
1156
- job_job?: string;
1157
- /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
1158
- */
1159
- job_name?: string;
1160
- /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
1161
- */
1162
- job_version?: string;
1163
- /** The data and time (UTC) the instance was launched
1164
- */
1165
- launched: string;
1166
- /** The Instance name
1167
- */
1168
- name: string;
1169
- /** The instance's known outputs, a JSON string defining a map of all the outputs. Typically applied only to JOB application types
1170
- */
1171
- outputs?: string;
1172
- /** The application instance owner, the person who launched the application and is the only user than can stop it.
1173
- */
1174
- owner: string;
1175
- /** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1176
- The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
1177
- */
1178
- phase: InstanceSummaryPhase;
1179
- /** The Project the instances is running in.
1180
- */
1181
- project_id: string;
1182
- /** The time the instance has spent running in the cluster. It's a string representation of a Python `timedelta`` object, e.g. `0:12:32` for a run-time of 12 minutes and 32 seconds. The run-time must be considered as an _estimate_ until the instance has stopped and the instance is only considered to be running once `started` has been set.
1183
- */
1184
- run_time: string;
1185
- /** The data and time (UTC) the instance started running
1186
- */
1187
- started?: string;
1188
- /** The data and time (UTC) the instance stopped running
1189
- */
1190
- stopped?: string;
1191
- /** For applications (not Jobs) this is the URL the application has exposed. It will only be available when the application has started.
1192
- */
1193
- url?: string;
1194
- }
1195
- interface FileStat {
1196
- /** The date and time (UTC) of the last modification
1197
- */
1198
- modified: string;
1199
- /** The size of the file in bytes
1200
- */
1201
- size: number;
1202
- }
1203
- interface FilePathFile {
1204
- /** The code obtained from the Account Server
1205
- */
1206
- authorisation_code?: number;
1207
- /** The file's Dataset ID (if the file belongs to a Dataset)
1208
- */
1209
- dataset_id?: string;
1210
- /** The file's Dataset version (if the file belongs to a Dataset)
1211
- */
1212
- dataset_version?: number;
1213
- /** The ID of the file (if the file belongs to a Dataset)
1214
- */
1215
- file_id?: string;
1216
- /** The file name
1217
- */
1218
- file_name: string;
1219
- /** Whether the file is immutable (read-only)
1220
- */
1221
- immutable?: boolean;
1222
- /** The file's MIME type
1223
- */
1224
- mime_type?: string;
1225
- /** The file's owner
1226
- */
1227
- owner: string;
1228
- stat: FileStat;
1229
- }
1230
- interface JobExchangeRateSummary {
1231
- collection: string;
1232
- id: number;
1233
- job: string;
1234
- rate?: string;
1235
- version: string;
1236
- }
1237
- interface ApplicationExchangeRateSummary {
1238
- id: string;
1239
- rate?: string;
1240
- }
1241
- interface ExchangeRateDetail {
1242
- comment?: string;
1243
- created: string;
1244
- id: number;
1245
- rate: string;
1246
- user_id: string;
1247
- }
1248
- /**
1249
- * The processing stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
1250
-
1251
- */
1252
- type DatasetVersionSummaryProcessingStage = typeof DatasetVersionSummaryProcessingStage[keyof typeof DatasetVersionSummaryProcessingStage];
1253
- declare const DatasetVersionSummaryProcessingStage: {
1254
- readonly COPYING: "COPYING";
1255
- readonly FAILED: "FAILED";
1256
- readonly FORMATTING: "FORMATTING";
1257
- readonly LOADING: "LOADING";
1258
- readonly DELETING: "DELETING";
1259
- readonly DONE: "DONE";
1260
- };
1261
- /**
1262
- * The dictionary of label/value pairs
1263
-
1264
- */
1265
- type DatasetVersionSummaryLabels = {
1266
- [key: string]: any;
1267
- };
1268
- interface DatasetVersionSummary {
1269
- /** The code obtained from the Account Server
1270
- */
1271
- authorisation_code?: number;
1272
- /** The name of the Pod handling the creation of the Dataset
1273
- */
1274
- creator_pod_name?: string;
1275
- /** If this is a Deleted dataset this is the date and time the dataset was deleted (an ISO-8601 formatted string in UTC)
1276
- */
1277
- deleted?: string;
1278
- /** If this is a Deleted dataset this is the username of the user that deleted the Dataset
1279
- */
1280
- deleting_user?: string;
1281
- /** The filename of the Dataset
1282
- */
1283
- file_name: string;
1284
- /** Any extra variables passed in during the upload and handed to the format-support container.
1285
- */
1286
- format_extra_variables?: string;
1287
- /** The dictionary of label/value pairs
1288
- */
1289
- labels?: DatasetVersionSummaryLabels;
1290
- /** The owner of the Dataset version
1291
- */
1292
- owner?: string;
1293
- /** The processing stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
1294
- */
1295
- processing_stage: DatasetVersionSummaryProcessingStage;
1296
- /** The list of Project's the Dataset is attached to
1297
- */
1298
- projects: string[];
1299
- /** The date and time the Dataset was uploaded (an ISO-8601 formatted string in UTC)
1300
- */
1301
- published: string;
1302
- /** The size, in bytes, of the formatted Dataset
1303
- */
1304
- size?: number;
1305
- /** The source of the Dataset - typically the name of the Dataset that was uploaded or a URL reference
1306
- */
1307
- source_ref: string;
1308
- /** The Dataset MIME type
1309
- */
1310
- type: string;
1311
- /** The version of the dataset
1312
- */
1313
- version: number;
1314
- }
1315
- interface DatasetVersionProjectFile {
1316
- files: string[];
1317
- project: string;
1318
- project_name: string;
1319
- }
1320
- /**
1321
- * The processing stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
1322
-
1323
- */
1324
- type DatasetVersionDetailProcessingStage = typeof DatasetVersionDetailProcessingStage[keyof typeof DatasetVersionDetailProcessingStage];
1325
- declare const DatasetVersionDetailProcessingStage: {
1326
- readonly COPYING: "COPYING";
1327
- readonly FAILED: "FAILED";
1328
- readonly FORMATTING: "FORMATTING";
1329
- readonly LOADING: "LOADING";
1330
- readonly DELETING: "DELETING";
1331
- readonly DONE: "DONE";
1332
- };
1333
- /**
1334
- * The dictionary of label/value pairs
1335
-
1336
- */
1337
- type DatasetVersionDetailLabels = {
1338
- [key: string]: any;
1339
- };
1340
- interface DatasetVersionDetail {
1341
- /** The code obtained from the Account Server
1342
- */
1343
- authorisation_code?: number;
1344
- /** The name of the Pod handling the creation of the Dataset
1345
- */
1346
- creator_pod_name?: string;
1347
- /** If this is a Deleted dataset this is the date and time the dataset was deleted (an ISO-8601 formatted string in UTC)
1348
- */
1349
- deleted?: string;
1350
- /** If this is a Deleted dataset this is the username of the user that deleted the Dataset
1351
- */
1352
- deleting_user?: string;
1353
- /** The filename of the Dataset
1354
- */
1355
- file_name: string;
1356
- /** Any extra variables passed in during the upload and handed to the format-support container.
1357
- */
1358
- format_extra_variables?: string;
1359
- /** The dictionary of label/value pairs
1360
- */
1361
- labels?: DatasetVersionDetailLabels;
1362
- /** The owner of the Dataset version
1363
- */
1364
- owner: string;
1365
- /** The processing stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
1366
- */
1367
- processing_stage: DatasetVersionDetailProcessingStage;
1368
- /** The list of
1369
- */
1370
- project_files: DatasetVersionProjectFile[];
1371
- /** The list of Project's the Dataset is attached to
1372
- */
1373
- projects: string[];
1374
- /** The date and time the Dataset was uploaded (an ISO-8601 formatted string in UTC)
1375
- */
1376
- published: string;
1377
- /** The size, in bytes, of the formatted Dataset
1378
- */
1379
- size?: number;
1380
- /** The source of the Dataset - typically the name of the Dataset that was uploaded or a URL reference
1381
- */
1382
- source_ref: string;
1383
- /** The Dataset MIME type
1384
- */
1385
- type: string;
1386
- /** The version of the dataset
1387
- */
1388
- version: number;
1389
- }
1390
- interface DatasetSummary {
1391
- /** The Dataset ID
1392
- */
1393
- dataset_id: string;
1394
- /** The list of editors
1395
- */
1396
- editors: string[];
1397
- /** The set of separate versions of the Dataset
1398
- */
1399
- versions: DatasetVersionSummary[];
1400
- }
1401
- interface DatasetDetail {
1402
- /** The Dataset ID
1403
- */
1404
- dataset_id: string;
1405
- /** The list of editors
1406
- */
1407
- editors: string[];
1408
- /** The owner of the Dataset
1409
- */
1410
- owner: string;
1411
- /** The set of separate versions of the Dataset
1412
- */
1413
- versions: DatasetVersionDetail[];
1414
- }
1415
- interface ApplicationSummary {
1416
- /** The application unique reference, the value of the Kubernetes **Custom Resource Definition** `metadata.name` property
1417
- */
1418
- application_id: string;
1419
- /** The application group
1420
- */
1421
- group?: string;
1422
- /** The application name, the value of the Kubernetes **Custom Resource Definition** `spec.names.kind` property
1423
- */
1424
- kind: string;
1425
- /** The application's latest version as declared in The **Custom Resource Definition**
1426
- */
1427
- latest_version: string;
1428
- }
1429
- interface ApplicationImageVariant {
1430
- image: string;
1431
- name: string;
1432
- }
1433
- interface ApplicationImageVariants {
1434
- public?: ApplicationImageVariant[];
1435
- }
1436
- /**
1437
- * The REST method used. GET methods are not logged
1438
-
1439
- */
1440
- type ApiLogDetailMethod = typeof ApiLogDetailMethod[keyof typeof ApiLogDetailMethod];
1441
- declare const ApiLogDetailMethod: {
1442
- readonly DELETE: "DELETE";
1443
- readonly PATCH: "PATCH";
1444
- readonly POST: "POST";
1445
- readonly PUT: "PUT";
1446
- };
1447
- interface ApiLogDetail {
1448
- /** The date/time the API call began
1449
- */
1450
- began: string;
1451
- /** A JSON string representing the in-body properties used in the call
1452
- */
1453
- body?: string;
1454
- /** The REST method approximate execution time (nS) in a humanised form, where 7969400 is presented as 7,969,400
1455
- */
1456
- duration_ns?: string;
1457
- /** Not all API calls using your user ID may have been executed by you, In cases where an administrator has executed a REST API call on your behalf, their user ID will be revealed using this property
1458
- */
1459
- impersonator?: string;
1460
- /** The REST method used. GET methods are not logged
1461
- */
1462
- method: ApiLogDetailMethod;
1463
- /** A JSON string representing the in-query properties used in the call
1464
- */
1465
- params?: string;
1466
- /** The API path used, e.g. `/dataset`
1467
- */
1468
- path: string;
1469
- /** The HTTP response status code
1470
- */
1471
- status_code?: number;
1472
- }
1473
- interface ModeGetResponse {
1474
- /** The Data Manager mode. The mode determines what features are available through the API. There are two modes, DEVELOPMENT, and PRODUCTION. In DEVELOPMENT mode some destructive operation are permitted (for example the removal of Job Definitions)
1475
- */
1476
- mode: string;
1477
- }
1478
- interface VersionGetResponse {
1479
- /** The Data Manager version. This is guaranteed to be a valid semantic version for official (tagged) images. The version value format for unofficial images is a string but otherwise undefined
1480
- */
1481
- version: string;
1482
- }
1483
- interface UsersGetResponse {
1484
- /** A list of Users that have used the Data Manager
1485
- */
1486
- users: UserSummary[];
1487
- }
1488
- interface UserApiLogGetResponse {
1489
- /** A list of API loc call records, with the oldest record first in the list
1490
- */
1491
- api_log: ApiLogDetail[];
1492
- }
1493
- type UserAccountGetResponse = UserAccountDetail;
1494
- interface TypesGetResponse {
1495
- /** A list of available MIME types
1496
- */
1497
- types: TypeSummary[];
1498
- }
1499
- interface TasksGetResponse {
1500
- /** A list of Tasks
1501
- */
1502
- tasks: TaskSummary[];
1503
- }
1504
- /**
1505
- * The purpose of the task. Tasks are typically executed for the purpose of Dataset processing, attaching as Project Files or Application Instance execution. Other fields in this object are only valid if the purpose is known (i.e. is not `UNKNOWN`)
1506
-
1507
- */
1508
- type TaskGetResponsePurpose = typeof TaskGetResponsePurpose[keyof typeof TaskGetResponsePurpose];
1509
- declare const TaskGetResponsePurpose: {
1510
- readonly DATASET: "DATASET";
1511
- readonly FILE: "FILE";
1512
- readonly INSTANCE: "INSTANCE";
1513
- readonly PROJECT: "PROJECT";
1514
- };
1515
- interface TaskGetResponse {
1516
- /** The date and time the task was created
1517
- */
1518
- created: string;
1519
- /** True if the task has run to completion. If the task finished successfully the `exit_code` will be zero.
1520
- */
1521
- done: boolean;
1522
- /** A (possibly empty) list of application events. The oldest event occupies the first position in the list.
1523
- */
1524
- events?: TaskEvent[];
1525
- /** Present when `done` and zero if the task finished successfully.
1526
- */
1527
- exit_code?: number;
1528
- /** If a container image is launched by the task the image name is available here
1529
- */
1530
- image?: string;
1531
- /** Is the Task Purpose is `INSTANCE`, and the instance was given a `specification` the specification can be found here. For **Applications** the specification is returned verbatim.
1532
- */
1533
- instance_specification?: string;
1534
- /** The purpose of the task. Tasks are typically executed for the purpose of Dataset processing, attaching as Project Files or Application Instance execution. Other fields in this object are only valid if the purpose is known (i.e. is not `UNKNOWN`)
1535
- */
1536
- purpose: TaskGetResponsePurpose;
1537
- /** The identity of the purpose, where available. This will be the Dataset UUID if the purpose of the task is/was for Dataset processing.
1538
- */
1539
- purpose_id: string;
1540
- /** The version number, relating to the object under control. For Datasets this will be the Dataset version.
1541
- */
1542
- purpose_version?: number;
1543
- /** True if the Task relates to an object removal, i.e. a DELETE
1544
- */
1545
- removal?: boolean;
1546
- /** A (possibly empty) list of application states, the oldest state occupies the first position in the list.
1547
- */
1548
- states?: TaskState[];
1549
- }
1550
- interface ServiceErrorsGetResponse {
1551
- /** A list of service errors
1552
- */
1553
- service_errors: ServiceErrorSummary[];
1554
- }
1555
- interface ProjectsGetResponse {
1556
- projects: ProjectDetail[];
1557
- }
1558
- interface ProjectPostResponse {
1559
- /** The project identity
1560
- */
1561
- project_id: string;
1562
- }
1563
- type ProjectGetResponse = ProjectDetail;
1564
- type ProjectDeleteResponse = TaskIdentity;
1565
- interface JobsGetResponse {
1566
- jobs: JobSummary[];
1567
- }
1568
- /**
1569
- * The optional container image type. Typically a single-container `SIMPLE` (where only one container runs) or a workflow where multiple container images can be spawned (like `NEXTFLOW`)
1570
-
1571
- */
1572
- type JobGetResponseImageType = typeof JobGetResponseImageType[keyof typeof JobGetResponseImageType];
1573
- declare const JobGetResponseImageType: {
1574
- readonly SIMPLE: "SIMPLE";
1575
- readonly NEXTFLOW: "NEXTFLOW";
1576
- };
1577
- interface JobGetResponse {
1578
- application: ApplicationSummary;
1579
- /** The Job's category
1580
- */
1581
- category?: string;
1582
- /** The Job collection
1583
- */
1584
- collection: string;
1585
- /** The Job command (usually encoded)
1586
- */
1587
- command: string;
1588
- /** The Job command encoding
1589
- */
1590
- command_encoding: string;
1591
- /** English description of the job
1592
- */
1593
- description?: string;
1594
- /** True if disabled. Disabled Jobs cannot be executed. If disabled a reason will be found in `disabled_reason`
1595
- */
1596
- disabled: boolean;
1597
- /** A reason why the Job has been disabled.
1598
- */
1599
- disabled_reason?: string;
1600
- /** A suggested remedy that accompanies the "disabled_reason". This provides the client with advice on how to avoid the reason that the Job's been disabled, for reasons that can be avoided (not all are).
1601
-
1602
- Where there is no remedy for a given reason the remedy will be "There is no remedy".
1603
- */
1604
- disabled_remedy?: string;
1605
- /** A URL linking to the Job documentation
1606
- */
1607
- doc_url?: string;
1608
- exchange_rate: string;
1609
- /** The Job's unique ID
1610
- */
1611
- id: number;
1612
- /** The name of the container image that houses the job
1613
- */
1614
- image_name: string;
1615
- /** The directory where the project volume will be mounted. The root path to the project files
1616
- */
1617
- image_project_directory: string;
1618
- /** The container image tag
1619
- */
1620
- image_tag: string;
1621
- /** The optional container image type. Typically a single-container `SIMPLE` (where only one container runs) or a workflow where multiple container images can be spawned (like `NEXTFLOW`)
1622
- */
1623
- image_type?: JobGetResponseImageType;
1624
- /** The directory used as the container image working directory (if defined)
1625
- */
1626
- image_working_directory?: unknown;
1627
- /** The Job name, unique within a given collection
1628
- */
1629
- job: string;
1630
- /** The list of keywords assigned to the Job
1631
- */
1632
- keywords?: string[];
1633
- /** A list of Account Server "required_assets" that cannot be found. If assets cannot be found the user will receive a "disabled_reason" that should explain the problem.
1634
- */
1635
- missing_assets?: string[];
1636
- /** The Job's descriptive name
1637
- */
1638
- name: string;
1639
- replaced_by?: JobReplacements;
1640
- replaces?: JobReplacements;
1641
- /** A list of Account Server assets names required to run the Job. You need access to these assets in order to run the Job
1642
- */
1643
- required_assets: string[];
1644
- variables?: JobVariables;
1645
- /** The Job version
1646
- */
1647
- version: string;
1648
- }
1649
- type InstanceTaskPurpose = typeof InstanceTaskPurpose[keyof typeof InstanceTaskPurpose];
1650
- declare const InstanceTaskPurpose: {
1651
- readonly CREATE: "CREATE";
1652
- readonly DELETE: "DELETE";
1653
- };
1654
- interface InstanceTask {
1655
- id: string;
1656
- purpose: InstanceTaskPurpose;
1657
- }
1658
- interface InstancesGetResponse {
1659
- instances: InstanceSummary[];
1660
- }
1661
- /**
1662
- * The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1663
- The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
1664
-
1665
- */
1666
- type InstanceGetResponsePhase = typeof InstanceGetResponsePhase[keyof typeof InstanceGetResponsePhase];
1667
- declare const InstanceGetResponsePhase: {
1668
- readonly COMPLETED: "COMPLETED";
1669
- readonly CRASH_LOOP_BACKOFF: "CRASH_LOOP_BACKOFF";
1670
- readonly FAILED: "FAILED";
1671
- readonly IMAGE_PULL_BACKOFF: "IMAGE_PULL_BACKOFF";
1672
- readonly PENDING: "PENDING";
1673
- readonly RUNNING: "RUNNING";
1674
- readonly SUCCEEDED: "SUCCEEDED";
1675
- readonly UNKNOWN: "UNKNOWN";
1676
- };
1677
- /**
1678
- * The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
1679
-
1680
- */
1681
- type InstanceGetResponseJobImageType = typeof InstanceGetResponseJobImageType[keyof typeof InstanceGetResponseJobImageType];
1682
- declare const InstanceGetResponseJobImageType: {
1683
- readonly SIMPLE: "SIMPLE";
1684
- readonly NEXTFLOW: "NEXTFLOW";
1685
- };
1686
- /**
1687
- * The type of Application, which can be a `job` or an `application`
1688
-
1689
- */
1690
- type InstanceGetResponseApplicationType = typeof InstanceGetResponseApplicationType[keyof typeof InstanceGetResponseApplicationType];
1691
- declare const InstanceGetResponseApplicationType: {
1692
- readonly APPLICATION: "APPLICATION";
1693
- readonly JOB: "JOB";
1694
- };
1695
- interface InstanceGetResponse {
1696
- /** The application ID
1697
- */
1698
- application_id: string;
1699
- /** The optional application specification. For **Applications** this is returned verbatim. For **Jobs** additional material will be found.
1700
- */
1701
- application_specification?: string;
1702
- /** The type of Application, which can be a `job` or an `application`
1703
- */
1704
- application_type: InstanceGetResponseApplicationType;
1705
- /** The application version
1706
- */
1707
- application_version: string;
1708
- /** True if the instance is archived (protected from automatic deletion)
1709
- */
1710
- archived: boolean;
1711
- /** The code obtained from the Account Server
1712
- */
1713
- authorisation_code?: number;
1714
- /** The accumulated coins accrued by the running Job. Coins are calculated based on the `cost` multiplied by the `launch_exchange_rate`. This is a string representation of a Decimal value, e.g. `'16.4'`
1715
- */
1716
- coins?: string;
1717
- /** Where available, this is the number of hours that the JOb would take if the collateral Pods had access to only one CPU core. Collateral Pods are all the pods created by the Job that are in addition to the main (controlling) Pod. A value of `'0.5'` implies the job would have run in 30 minutes on 1 core. The minimum time resolution is 0.001 (3.6 seconds).
1718
- */
1719
- collateral_cpu_hours?: string;
1720
- /** Where available, the number of collateral Pods spawned by the instance, typically used by Job instances. Collateral Pods are all the pods created by the Job that are in addition to the main (controlling) Pod. For `NEXTFLOW` jobs this is a count of the number of Task pods spawned.
1721
- */
1722
- collateral_pod_count?: number;
1723
- /** The accumulated cost accrued by the running Job. Depending on the the Job, this is either known when the Job completes or may change as the Job runs. This is a string representation of a Decimal value, e.g. `'32.8'`
1724
- */
1725
- cost?: string;
1726
- /** An optional error message, used to report underlying problems.
1727
- */
1728
- error_message?: string;
1729
- /** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes.
1730
- */
1731
- fix_permissions?: boolean;
1732
- /** Set if the instance has a valid callback token. Instances with a valid token allow users to read files form the project without authentication
1733
- */
1734
- has_valid_callback_token: boolean;
1735
- /** If the instance relates to a job, this will be the job collection, as defined in the original collection's job definition.
1736
- */
1737
- job_collection?: string;
1738
- /** The Job definition's unique ID
1739
- */
1740
- job_id?: number;
1741
- /** The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
1742
- */
1743
- job_image_type?: InstanceGetResponseJobImageType;
1744
- /** If the instance relates to a job, this will be the job, as defined in the original collection's job definition.
1745
- */
1746
- job_job?: string;
1747
- /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
1748
- */
1749
- job_name?: string;
1750
- /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
1751
- */
1752
- job_version?: string;
1753
- /** The cost exchange rate that applies to the Job at the time of launch. This is a string representation of a Decimal, e.g. `'0.5'`
1754
- */
1755
- launch_exchange_rate?: string;
1756
- /** The date and time the instance was started, an ISO-8601 format string.
1757
- */
1758
- launched: string;
1759
- /** The application name
1760
- */
1761
- name: string;
1762
- /** The JSON string representation of the JobDefinition's outputs
1763
- */
1764
- outputs?: string;
1765
- /** The application owner, the person who launched the application and is the only user than can stop it.
1766
- */
1767
- owner: string;
1768
- /** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1769
- The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
1770
- */
1771
- phase: InstanceGetResponsePhase;
1772
- /** The Project the Instance is running in
1773
- */
1774
- project_id: string;
1775
- /** The time the instance has spent running in the cluster. It's a string representation of a Python timedelta object, e.g. `0:12:32` for a run-time of 12 minutes and 32 seconds. The run-time must be considered as an _estimate_ until the instance has stopped and the instance is only considered to be running once `started` has been set.
1776
- */
1777
- run_time: string;
1778
- /** The date and time the instance started running in the cluster. This is typically close to the launch time but contention may mean the instance starts only when resources are available.
1779
- */
1780
- started?: string;
1781
- /** The date and time the instance stopped, an ISO-8601 format string.
1782
- */
1783
- stopped?: string;
1784
- /** A list of Tasks related to the application. Tasks are responsible for creating and deleting the instance. You should fins at least one, assuming the corresponding task has not been deleted.
1785
- */
1786
- tasks: InstanceTask[];
1787
- /** The application endpoint
1788
- */
1789
- url?: string;
1790
- }
1791
- type GetExchangeRatesResponseId = number | string;
1792
- interface GetExchangeRatesResponse {
1793
- exchange_rates: ExchangeRateDetail[];
1794
- id: GetExchangeRatesResponseId;
1795
- }
1796
- type GetAllExchangeRatesResponseExchangeRatesItem = ApplicationExchangeRateSummary | JobExchangeRateSummary;
1797
- interface GetAllExchangeRatesResponse {
1798
- exchange_rates: GetAllExchangeRatesResponseExchangeRatesItem[];
1799
- only_undefined: boolean;
1800
- }
1801
- interface FilesGetResponse {
1802
- /** The dataset identity (not its name). A unique reference assigned automatically when uploaded
1803
- */
1804
- files: FilePathFile[];
1805
- /** The project path
1806
- */
1807
- path: string;
1808
- /** Sub-directories in the current path
1809
- */
1810
- paths: string[];
1811
- /** The project
1812
- */
1813
- project_id: string;
1814
- }
1815
- interface FilePostResponse {
1816
- /** The Project File identity, assigned automatically when a Dataset is added to a Project
1817
- */
1818
- file_id: string;
1819
- /** The name of the File that will appear in the Project
1820
- */
1821
- file_name: string;
1822
- /** The path to the file in the Project, relative to the volume root (mount point). Files in the root of the project will have a path value of '/'
1823
- */
1824
- file_path: string;
1825
- /** The File task identity. The task assigned to convert and attach the Dataset File to the Project
1826
- */
1827
- task_id: string;
1828
- }
1829
- interface InstancePostResponse {
1830
- /** A token that can be used to access data in the project without further authentication. The token expires automatically or if the user revokes it. The token is only provided if asked for when the instance is launched.
1831
- */
1832
- callback_token?: string;
1833
- /** The instance expanded command. Applies only to Job instances.
1834
- */
1835
- command?: string;
1836
- /** The application instance identity (not its name). Assigned automatically when created
1837
- */
1838
- instance_id: string;
1839
- /** The instance task identity. The task assigned to process the instance
1840
- */
1841
- task_id: string;
1842
- }
1843
- interface InstanceDryRunPostResponse {
1844
- /** A token that can be used to access data in the project without further authentication. The token expires automatically or if the user revokes it.
1845
- */
1846
- callback_token?: string;
1847
- /** The instance expanded command. Applies only to Job instances.
1848
- */
1849
- command?: string;
1850
- }
1851
- type InstanceDeleteResponse = TaskIdentity;
1852
- interface DatasetsGetResponse {
1853
- datasets: DatasetSummary[];
1854
- }
1855
- type DatasetVersionsGetResponse = DatasetDetail;
1856
- type DatasetVersionDeleteResponse = TaskIdentity;
1857
- /**
1858
- * The Metadata type (an object)
1859
-
1860
- */
1861
- type DatasetSchemaGetResponseType = typeof DatasetSchemaGetResponseType[keyof typeof DatasetSchemaGetResponseType];
1862
- declare const DatasetSchemaGetResponseType: {
1863
- readonly object: "object";
1864
- };
1865
- interface DatasetSchemaGetResponse {
1866
- /** The Metadata description
1867
- */
1868
- description: string;
1869
- /** Required properties
1870
- */
1871
- required: string[];
1872
- /** The Metadata title
1873
- */
1874
- title: string;
1875
- /** The Metadata type (an object)
1876
- */
1877
- type: DatasetSchemaGetResponseType;
1878
- [key: string]: any;
1879
- }
1880
- interface DatasetMetaGetResponse {
1881
- /** The Metadata's annotations
1882
- */
1883
- annotations: unknown[];
1884
- /** The date and time of creation
1885
- */
1886
- created: string;
1887
- /** The user who created the Metadata
1888
- */
1889
- created_by: string;
1890
- /** The Metadata description
1891
- */
1892
- dataset_id: string;
1893
- /** The Metadata title
1894
- */
1895
- dataset_name: string;
1896
- /** The Metadata type (an object)
1897
- */
1898
- description: string;
1899
- /** The Metadata's labels
1900
- */
1901
- labels: unknown[];
1902
- /** The date and time it was last updated
1903
- */
1904
- last_updated: string;
1905
- /** The Metadata version
1906
- */
1907
- metadata_version: string;
1908
- [key: string]: any;
1909
- }
1910
- interface DatasetDigestGetResponse {
1911
- /** The Dataset matching the digest
1912
- */
1913
- dataset_id: string;
1914
- /** The Dataset version
1915
- */
1916
- dataset_version: number;
1917
- }
1918
- interface DatasetPutPostResponse {
1919
- /** The dataset identity (not its name). Assigned automatically when uploaded
1920
- */
1921
- dataset_id: string;
1922
- /** The dataset identity version. Assigned automatically when uploaded
1923
- */
1924
- dataset_version: number;
1925
- /** The dataset task identity. The task assigned to process the dataset
1926
- */
1927
- task_id: string;
1928
- }
1929
- interface ApplicationsGetResponse {
1930
- /** A list of installed applications, which are application-compliant Kubernetes "operators"
1931
- */
1932
- applications: ApplicationSummary[];
1933
- }
1934
- interface ApplicationGetResponse {
1935
- /** The Application COST exchange rate
1936
- */
1937
- exchange_rate: string;
1938
- /** The application group
1939
- */
1940
- group: string;
1941
- /** The Application's unique ID
1942
- */
1943
- id: string;
1944
- image_variants?: ApplicationImageVariants;
1945
- /** A list of instances of the application
1946
- */
1947
- instances: string[];
1948
- /** The name (kind) of the application
1949
- */
1950
- kind: string;
1951
- /** The application specification template. Used when creating application instances
1952
- */
1953
- template: string;
1954
- /** The list of available versions
1955
- */
1956
- versions: string[];
1957
- }
1958
- interface AdminUsersGetResponse {
1959
- /** A list of Users that have used the Data Manager
1960
- */
1961
- users: UserDetail[];
1962
- }
1963
- type AdminUserPutResponse = UserAccountDetail;
1964
- interface AdminJobManifestLoadPutResponse {
1965
- /** The number of Job Definitions inspected
1966
- */
1967
- job_definitions_inspected: number;
1968
- /** The number of Jobs inspected
1969
- */
1970
- jobs_inspected: number;
1971
- /** The number of Job Manifests inspected
1972
- */
1973
- manifests_inspected: number;
1974
- /** True if successful, false otherwise
1975
- */
1976
- status: boolean;
1977
- }
1978
- interface AdminJobManifestGetResponse {
1979
- /** The list of known Job manifests
1980
- */
1981
- job_manifests: JobManifestDetail[];
1982
- }
1983
- interface AccountServerGetNamespaceResponse {
1984
- /** The configured Account Server namespace, which will be an empty string if one is not configured. The AS API is expected as the service `as-api` in this namespace.
1985
- */
1986
- namespace: string;
1987
- }
1988
- interface AccountServerGetRegistrationResponse {
1989
- merchant_id: number;
1990
- name: string;
1991
- registered: string;
1992
- }
1993
- interface DmError {
1994
- /** Brief error text that can be presented to the user
1995
- */
1996
- error: string;
1997
- }
1998
-
1999
- declare const AXIOS_INSTANCE: axios.AxiosInstance;
2000
- /**
2001
- * Set the access token to be added as the `Authorization: Bearer 'token'` header
2002
- * Useful for client only apps where a proxy API route isn't involved to securely add the access token
2003
- * @param token access token
2004
- */
2005
- declare const setAuthToken: (token: string) => void;
2006
- /**
2007
- * Set the url to which request paths are added to.
2008
- * @param baseUrl origin + subpath e.g. 'https://example.com/subpath' or '/subpath'
2009
- */
2010
- declare const setBaseUrl: (baseUrl: string) => void;
2011
- declare const customInstance: <TReturn>(config: AxiosRequestConfig, options?: AxiosRequestConfig) => Promise<TReturn>;
2012
- type ErrorType<TError> = AxiosError<TError>;
2013
-
2014
- export { QExcludeRemovalParameter as $, AdminDeleteJobManifestParams as A, QInstanceCallbackContextParameter as B, CreatePathParams as C, DeleteUnmanagedFileParams as D, QProjectNameParameter as E, QProjectIdParameter as F, GetUserApiLogParams as G, QLabelsParameter as H, QOnlyUndefinedParameter as I, QKeepProjectFilesParameter as J, QJobVersionParameter as K, QJobJobParameter as L, QJobIdParameter as M, QJobCollectionParameter as N, QInstanceArchiveParameter as O, PatchInstanceParams as P, QEditorsParameter as Q, QIncludeHiddenParameter as R, QIncludeDeletedParameter as S, QIncludeAcknowlegedParameter as T, QFromParameter as U, QFileProjectIdParameter as V, QFilePathParameter as W, QFileParameter as X, QActiveDaysParameter as Y, QIdleDaysParameter as Z, QExcludePurposeParameter as _, AdminGetUsersParams as a, DatasetVersionDetailLabels as a$, QExcludeDoneParameter as a0, QEventPriorOrdinalParameter as a1, QEventLimitParameter as a2, QDatasetMimeTypeParameter as a3, QDoNotImpersonateParameter as a4, QCurrentParameter as a5, QApplicationIdParameter as a6, UserPatchBodyBody as a7, UserAccountPatchBodyBody as a8, ProjectPostBodyBody as a9, ProjectFileDetail as aA, ProjectDetail as aB, JobReplacement as aC, JobReplacements as aD, JobOrderDetail as aE, JobVariablesOutputs as aF, JobVariablesOptions as aG, JobVariablesInputs as aH, JobVariables as aI, JobSummaryImageType as aJ, JobSummary as aK, JobManifestDetail as aL, JobApplication as aM, InstanceSummaryPhase as aN, InstanceSummaryJobImageType as aO, InstanceSummaryApplicationType as aP, InstanceSummary as aQ, FileStat as aR, FilePathFile as aS, JobExchangeRateSummary as aT, ApplicationExchangeRateSummary as aU, ExchangeRateDetail as aV, DatasetVersionSummaryProcessingStage as aW, DatasetVersionSummaryLabels as aX, DatasetVersionSummary as aY, DatasetVersionProjectFile as aZ, DatasetVersionDetailProcessingStage as a_, ProjectPatchBodyBody as aa, ProjectFilePutBodyBody as ab, ExchangeRatePutBodyBody as ac, JobManifestPutBodyBody as ad, InstancePostBodyBody as ae, FilePostBodyBody as af, DatasetPutBodyBody as ag, DatasetVersionMetaPostBodyBody as ah, DatasetMetaPostBodyBody as ai, DatasetPostBodyBody as aj, AsAdditionalDataProcessingCharge as ak, UserSummary as al, UserDetail as am, UserAccountDetail as an, TypeSummaryFormatterOptionsType as ao, TypeSummaryFormatterOptions as ap, TypeSummary as aq, TaskSummaryProcessingStage as ar, TaskSummary as as, TaskStateState as at, TaskState as au, TaskIdentity as av, TaskEventLevel as aw, TaskEvent as ax, ServiceErrorSummarySeverity as ay, ServiceErrorSummary as az, AdminGetServiceErrorsParams as b, DatasetVersionDetail as b0, DatasetSummary as b1, DatasetDetail as b2, ApplicationSummary as b3, ApplicationImageVariant as b4, ApplicationImageVariants as b5, ApiLogDetailMethod as b6, ApiLogDetail as b7, ModeGetResponse as b8, VersionGetResponse as b9, FilesGetResponse as bA, FilePostResponse as bB, InstancePostResponse as bC, InstanceDryRunPostResponse as bD, InstanceDeleteResponse as bE, DatasetsGetResponse as bF, DatasetVersionsGetResponse as bG, DatasetVersionDeleteResponse as bH, DatasetSchemaGetResponseType as bI, DatasetSchemaGetResponse as bJ, DatasetMetaGetResponse as bK, DatasetDigestGetResponse as bL, DatasetPutPostResponse as bM, ApplicationsGetResponse as bN, ApplicationGetResponse as bO, AdminUsersGetResponse as bP, AdminUserPutResponse as bQ, AdminJobManifestLoadPutResponse as bR, AdminJobManifestGetResponse as bS, AccountServerGetNamespaceResponse as bT, AccountServerGetRegistrationResponse as bU, DmError as bV, AXIOS_INSTANCE as bW, setAuthToken as bX, setBaseUrl as bY, customInstance as bZ, ErrorType as b_, UsersGetResponse as ba, UserApiLogGetResponse as bb, UserAccountGetResponse as bc, TypesGetResponse as bd, TasksGetResponse as be, TaskGetResponsePurpose as bf, TaskGetResponse as bg, ServiceErrorsGetResponse as bh, ProjectsGetResponse as bi, ProjectPostResponse as bj, ProjectGetResponse as bk, ProjectDeleteResponse as bl, JobsGetResponse as bm, JobGetResponseImageType as bn, JobGetResponse as bo, InstanceTaskPurpose as bp, InstanceTask as bq, InstancesGetResponse as br, InstanceGetResponsePhase as bs, InstanceGetResponseJobImageType as bt, InstanceGetResponseApplicationType as bu, InstanceGetResponse as bv, GetExchangeRatesResponseId as bw, GetExchangeRatesResponse as bx, GetAllExchangeRatesResponseExchangeRatesItem as by, GetAllExchangeRatesResponse as bz, GetUserAccountParams as c, GetInstancesParams as d, GetJobExchangeRatesParams as e, GetAllJobExchangeRatesParams as f, GetJobParams as g, GetJobByVersionParams as h, GetJobsParams as i, GetApplicationExchangeRatesParams as j, GetAllApplicationExchangeRatesParams as k, GetTaskParams as l, GetTasksParams as m, GetFilesParams as n, DeleteDatasetParams as o, GetVersionsParams as p, GetDatasetsParams as q, GetProjectFileWithTokenParams as r, GetProjectFileParams as s, GetProjectsParams as t, DeletePathParams as u, QPurgeParameter as v, QOwnersParameter as w, QUsernameParameter as x, QUntilParameter as y, QTokenParameter as z };