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