@squonk/data-manager-client 0.7.10 → 0.7.11-rc.3
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 +10 -8
- package/accounting/accounting.cjs.map +1 -1
- package/accounting/accounting.d.ts +9 -8
- package/accounting/accounting.js +10 -8
- package/accounting/accounting.js.map +1 -1
- package/admin/admin.cjs +17 -17
- package/admin/admin.cjs.map +1 -1
- package/admin/admin.d.ts +13 -12
- package/admin/admin.js +17 -17
- package/admin/admin.js.map +1 -1
- package/application/application.cjs +12 -8
- package/application/application.cjs.map +1 -1
- package/application/application.d.ts +9 -8
- package/application/application.js +12 -8
- package/application/application.js.map +1 -1
- package/{custom-instance-6e6b0801.d.ts → custom-instance-da4fff1f.d.ts} +144 -116
- package/dataset/dataset.cjs +42 -30
- package/dataset/dataset.cjs.map +1 -1
- package/dataset/dataset.d.ts +19 -18
- package/dataset/dataset.js +42 -30
- package/dataset/dataset.js.map +1 -1
- package/file/file.cjs +18 -14
- package/file/file.cjs.map +1 -1
- package/file/file.d.ts +11 -10
- package/file/file.js +18 -14
- package/file/file.js.map +1 -1
- package/index.cjs.map +1 -1
- package/index.d.ts +1 -1
- package/index.js.map +1 -1
- package/instance/instance.cjs +35 -15
- package/instance/instance.cjs.map +1 -1
- package/instance/instance.d.ts +33 -10
- package/instance/instance.js +34 -14
- package/instance/instance.js.map +1 -1
- package/job/job.cjs +12 -8
- package/job/job.cjs.map +1 -1
- package/job/job.d.ts +9 -8
- package/job/job.js +12 -8
- package/job/job.js.map +1 -1
- package/metadata/metadata.cjs +18 -12
- package/metadata/metadata.cjs.map +1 -1
- package/metadata/metadata.d.ts +10 -9
- package/metadata/metadata.js +18 -12
- package/metadata/metadata.js.map +1 -1
- package/package.json +9 -9
- package/project/project.cjs +52 -25
- package/project/project.cjs.map +1 -1
- package/project/project.d.ts +35 -15
- package/project/project.js +51 -24
- package/project/project.js.map +1 -1
- package/src/accounting/accounting.ts +29 -25
- package/src/admin/admin.ts +55 -57
- package/src/application/application.ts +30 -29
- package/src/data-manager-api.schemas.ts +178 -180
- package/src/dataset/dataset.ts +113 -90
- package/src/file/file.ts +54 -47
- package/src/instance/instance.ts +118 -51
- package/src/job/job.ts +30 -25
- package/src/metadata/metadata.ts +50 -41
- package/src/project/project.ts +163 -78
- package/src/task/task.ts +40 -31
- package/src/type/type.ts +23 -20
- package/src/user/user.ts +55 -48
- package/task/task.cjs +14 -10
- package/task/task.cjs.map +1 -1
- package/task/task.d.ts +9 -8
- package/task/task.js +14 -10
- package/task/task.js.map +1 -1
- package/type/type.cjs +6 -4
- package/type/type.cjs.map +1 -1
- package/type/type.d.ts +7 -6
- package/type/type.js +6 -4
- package/type/type.js.map +1 -1
- package/user/user.cjs +20 -14
- package/user/user.cjs.map +1 -1
- package/user/user.d.ts +11 -10
- package/user/user.js +20 -14
- package/user/user.js.map +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Generated by orval v6.
|
|
2
|
+
* Generated by orval v6.8.0 🍺
|
|
3
3
|
* Do not edit manually.
|
|
4
4
|
* Dataset Manager API
|
|
5
5
|
* The Dataset Manager API service.
|
|
@@ -17,10 +17,26 @@ export type GetUserApiLogParams = {
|
|
|
17
17
|
until?: QUntilParameter;
|
|
18
18
|
};
|
|
19
19
|
|
|
20
|
+
export type GetUserAccountParams = {
|
|
21
|
+
do_not_impersonate?: QDoNotImpersonateParameter;
|
|
22
|
+
};
|
|
23
|
+
|
|
20
24
|
export type PatchInstanceParams = { archive?: QInstanceArchiveParameter };
|
|
21
25
|
|
|
22
26
|
export type GetInstancesParams = { project_id?: QProjectIdParameter };
|
|
23
27
|
|
|
28
|
+
/**
|
|
29
|
+
* 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.
|
|
30
|
+
|
|
31
|
+
*/
|
|
32
|
+
export type QEventPriorOrdinalParameter = number;
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* Maximum number of events to return. If provided, can be 1 or more.
|
|
36
|
+
|
|
37
|
+
*/
|
|
38
|
+
export type QEventLimitParameter = number;
|
|
39
|
+
|
|
24
40
|
export type GetTaskParams = {
|
|
25
41
|
event_limit?: QEventLimitParameter;
|
|
26
42
|
event_prior_ordinal?: QEventPriorOrdinalParameter;
|
|
@@ -50,6 +66,27 @@ export type DeleteDatasetParams = {
|
|
|
50
66
|
|
|
51
67
|
export type GetVersionsParams = { include_deleted?: QIncludeDeletedParameter };
|
|
52
68
|
|
|
69
|
+
/**
|
|
70
|
+
* Filter the datasets by the supplied mime_type.
|
|
71
|
+
|
|
72
|
+
*/
|
|
73
|
+
export type QDatasetMimeTypeParameter = string;
|
|
74
|
+
|
|
75
|
+
export type GetDatasetsParams = {
|
|
76
|
+
include_deleted?: QIncludeDeletedParameter;
|
|
77
|
+
username?: QUsernameParameter;
|
|
78
|
+
dataset_mime_type?: QDatasetMimeTypeParameter;
|
|
79
|
+
owners?: QOwnersParameter;
|
|
80
|
+
editors?: QEditorsParameter;
|
|
81
|
+
labels?: QLabelsParameter;
|
|
82
|
+
};
|
|
83
|
+
|
|
84
|
+
export type GetProjectFileWithTokenParams = {
|
|
85
|
+
token?: QTokenParameter;
|
|
86
|
+
path?: QFilePathParameter;
|
|
87
|
+
file: QFileParameter;
|
|
88
|
+
};
|
|
89
|
+
|
|
53
90
|
export type GetProjectFileParams = {
|
|
54
91
|
path?: QFilePathParameter;
|
|
55
92
|
file: QFileParameter;
|
|
@@ -79,6 +116,11 @@ export type QUsernameParameter = string;
|
|
|
79
116
|
*/
|
|
80
117
|
export type QUntilParameter = string;
|
|
81
118
|
|
|
119
|
+
/**
|
|
120
|
+
* A token
|
|
121
|
+
*/
|
|
122
|
+
export type QTokenParameter = string;
|
|
123
|
+
|
|
82
124
|
/**
|
|
83
125
|
* A Project identity
|
|
84
126
|
*/
|
|
@@ -90,15 +132,6 @@ export type QProjectIdParameter = string;
|
|
|
90
132
|
*/
|
|
91
133
|
export type QLabelsParameter = string;
|
|
92
134
|
|
|
93
|
-
export type GetDatasetsParams = {
|
|
94
|
-
include_deleted?: QIncludeDeletedParameter;
|
|
95
|
-
username?: QUsernameParameter;
|
|
96
|
-
dataset_mime_type?: QDatasetMimeTypeParameter;
|
|
97
|
-
owners?: QOwnersParameter;
|
|
98
|
-
editors?: QEditorsParameter;
|
|
99
|
-
labels?: QLabelsParameter;
|
|
100
|
-
};
|
|
101
|
-
|
|
102
135
|
/**
|
|
103
136
|
* Whether to convert Project managed file instances to unmanged files
|
|
104
137
|
|
|
@@ -161,34 +194,12 @@ export type QExcludePurposeParameter = string;
|
|
|
161
194
|
*/
|
|
162
195
|
export type QExcludeDoneParameter = boolean;
|
|
163
196
|
|
|
164
|
-
/**
|
|
165
|
-
* 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.
|
|
166
|
-
|
|
167
|
-
*/
|
|
168
|
-
export type QEventPriorOrdinalParameter = number;
|
|
169
|
-
|
|
170
|
-
/**
|
|
171
|
-
* Maximum number of events to return. If provided, can be 1 or more.
|
|
172
|
-
|
|
173
|
-
*/
|
|
174
|
-
export type QEventLimitParameter = number;
|
|
175
|
-
|
|
176
|
-
/**
|
|
177
|
-
* Filter the datasets by the supplied mime_type.
|
|
178
|
-
|
|
179
|
-
*/
|
|
180
|
-
export type QDatasetMimeTypeParameter = string;
|
|
181
|
-
|
|
182
197
|
/**
|
|
183
198
|
* Set, if you're an admin, to call the endpoint without impersonation
|
|
184
199
|
|
|
185
200
|
*/
|
|
186
201
|
export type QDoNotImpersonateParameter = boolean;
|
|
187
202
|
|
|
188
|
-
export type GetUserAccountParams = {
|
|
189
|
-
do_not_impersonate?: QDoNotImpersonateParameter;
|
|
190
|
-
};
|
|
191
|
-
|
|
192
203
|
export type UserPatchBodyBody = {
|
|
193
204
|
/** 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 accont can be restored by setting the message to `/restore`
|
|
194
205
|
*/
|
|
@@ -271,6 +282,13 @@ export type InstancePostBodyBody = {
|
|
|
271
282
|
/** 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
|
|
272
283
|
*/
|
|
273
284
|
callback_context?: string;
|
|
285
|
+
/** 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.
|
|
286
|
+
|
|
287
|
+
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.
|
|
288
|
+
|
|
289
|
+
Tokens should therefore be revoked when they're no longer required
|
|
290
|
+
*/
|
|
291
|
+
generate_callback_token?: boolean;
|
|
274
292
|
/** A debug value that may be used by the instance.
|
|
275
293
|
|
|
276
294
|
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.
|
|
@@ -426,12 +444,13 @@ export interface UserAccountDetail {
|
|
|
426
444
|
* The Schema type (an object)
|
|
427
445
|
|
|
428
446
|
*/
|
|
429
|
-
export type TypeSummaryFormatterOptionsType =
|
|
447
|
+
export type TypeSummaryFormatterOptionsType =
|
|
448
|
+
typeof TypeSummaryFormatterOptionsType[keyof typeof TypeSummaryFormatterOptionsType];
|
|
430
449
|
|
|
431
450
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
432
451
|
export const TypeSummaryFormatterOptionsType = {
|
|
433
|
-
object: "object"
|
|
434
|
-
};
|
|
452
|
+
object: "object",
|
|
453
|
+
} as const;
|
|
435
454
|
|
|
436
455
|
/**
|
|
437
456
|
* If present, contains the formatter_options that can be entered in the format_extra_variables field in the POST /dataset api.
|
|
@@ -473,22 +492,17 @@ export interface TypeSummary {
|
|
|
473
492
|
|
|
474
493
|
*/
|
|
475
494
|
export type TaskSummaryProcessingStage =
|
|
476
|
-
|
|
477
|
-
| "FAILED"
|
|
478
|
-
| "FORMATTING"
|
|
479
|
-
| "LOADING"
|
|
480
|
-
| "DELETING"
|
|
481
|
-
| "DONE";
|
|
495
|
+
typeof TaskSummaryProcessingStage[keyof typeof TaskSummaryProcessingStage];
|
|
482
496
|
|
|
483
497
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
484
498
|
export const TaskSummaryProcessingStage = {
|
|
485
|
-
COPYING: "COPYING"
|
|
486
|
-
FAILED: "FAILED"
|
|
487
|
-
FORMATTING: "FORMATTING"
|
|
488
|
-
LOADING: "LOADING"
|
|
489
|
-
DELETING: "DELETING"
|
|
490
|
-
DONE: "DONE"
|
|
491
|
-
};
|
|
499
|
+
COPYING: "COPYING",
|
|
500
|
+
FAILED: "FAILED",
|
|
501
|
+
FORMATTING: "FORMATTING",
|
|
502
|
+
LOADING: "LOADING",
|
|
503
|
+
DELETING: "DELETING",
|
|
504
|
+
DONE: "DONE",
|
|
505
|
+
} as const;
|
|
492
506
|
|
|
493
507
|
export interface TaskSummary {
|
|
494
508
|
/** The Task UUID
|
|
@@ -527,21 +541,16 @@ export interface TaskSummary {
|
|
|
527
541
|
* The task state. The typical state sequence is `PENDING`, then `STARTED` and finally `SUCCESS`
|
|
528
542
|
|
|
529
543
|
*/
|
|
530
|
-
export type TaskStateState =
|
|
531
|
-
| "PENDING"
|
|
532
|
-
| "STARTED"
|
|
533
|
-
| "RETRY"
|
|
534
|
-
| "SUCCESS"
|
|
535
|
-
| "FAILURE";
|
|
544
|
+
export type TaskStateState = typeof TaskStateState[keyof typeof TaskStateState];
|
|
536
545
|
|
|
537
546
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
538
547
|
export const TaskStateState = {
|
|
539
|
-
PENDING: "PENDING"
|
|
540
|
-
STARTED: "STARTED"
|
|
541
|
-
RETRY: "RETRY"
|
|
542
|
-
SUCCESS: "SUCCESS"
|
|
543
|
-
FAILURE: "FAILURE"
|
|
544
|
-
};
|
|
548
|
+
PENDING: "PENDING",
|
|
549
|
+
STARTED: "STARTED",
|
|
550
|
+
RETRY: "RETRY",
|
|
551
|
+
SUCCESS: "SUCCESS",
|
|
552
|
+
FAILURE: "FAILURE",
|
|
553
|
+
} as const;
|
|
545
554
|
|
|
546
555
|
export interface TaskState {
|
|
547
556
|
/** The task state. The typical state sequence is `PENDING`, then `STARTED` and finally `SUCCESS`
|
|
@@ -563,21 +572,16 @@ export interface TaskIdentity {
|
|
|
563
572
|
* The level of the message, a typical logging framework value
|
|
564
573
|
|
|
565
574
|
*/
|
|
566
|
-
export type TaskEventLevel =
|
|
567
|
-
| "CRITICAL"
|
|
568
|
-
| "ERROR"
|
|
569
|
-
| "WARNING"
|
|
570
|
-
| "INFO"
|
|
571
|
-
| "DEBUG";
|
|
575
|
+
export type TaskEventLevel = typeof TaskEventLevel[keyof typeof TaskEventLevel];
|
|
572
576
|
|
|
573
577
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
574
578
|
export const TaskEventLevel = {
|
|
575
|
-
CRITICAL: "CRITICAL"
|
|
576
|
-
ERROR: "ERROR"
|
|
577
|
-
WARNING: "WARNING"
|
|
578
|
-
INFO: "INFO"
|
|
579
|
-
DEBUG: "DEBUG"
|
|
580
|
-
};
|
|
579
|
+
CRITICAL: "CRITICAL",
|
|
580
|
+
ERROR: "ERROR",
|
|
581
|
+
WARNING: "WARNING",
|
|
582
|
+
INFO: "INFO",
|
|
583
|
+
DEBUG: "DEBUG",
|
|
584
|
+
} as const;
|
|
581
585
|
|
|
582
586
|
export interface TaskEvent {
|
|
583
587
|
/** The event sequence number. The first event is always '1'.
|
|
@@ -594,14 +598,15 @@ export interface TaskEvent {
|
|
|
594
598
|
time: string;
|
|
595
599
|
}
|
|
596
600
|
|
|
597
|
-
export type ServiceErrorSummarySeverity =
|
|
601
|
+
export type ServiceErrorSummarySeverity =
|
|
602
|
+
typeof ServiceErrorSummarySeverity[keyof typeof ServiceErrorSummarySeverity];
|
|
598
603
|
|
|
599
604
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
600
605
|
export const ServiceErrorSummarySeverity = {
|
|
601
|
-
CRITICAL: "CRITICAL"
|
|
602
|
-
ERROR: "ERROR"
|
|
603
|
-
WARNING: "WARNING"
|
|
604
|
-
};
|
|
606
|
+
CRITICAL: "CRITICAL",
|
|
607
|
+
ERROR: "ERROR",
|
|
608
|
+
WARNING: "WARNING",
|
|
609
|
+
} as const;
|
|
605
610
|
|
|
606
611
|
export interface ServiceErrorSummary {
|
|
607
612
|
id: number;
|
|
@@ -703,13 +708,14 @@ export interface JobVariables {
|
|
|
703
708
|
* 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)
|
|
704
709
|
|
|
705
710
|
*/
|
|
706
|
-
export type JobSummaryImageType =
|
|
711
|
+
export type JobSummaryImageType =
|
|
712
|
+
typeof JobSummaryImageType[keyof typeof JobSummaryImageType];
|
|
707
713
|
|
|
708
714
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
709
715
|
export const JobSummaryImageType = {
|
|
710
|
-
SIMPLE: "SIMPLE"
|
|
711
|
-
NEXTFLOW: "NEXTFLOW"
|
|
712
|
-
};
|
|
716
|
+
SIMPLE: "SIMPLE",
|
|
717
|
+
NEXTFLOW: "NEXTFLOW",
|
|
718
|
+
} as const;
|
|
713
719
|
|
|
714
720
|
export interface JobSummary {
|
|
715
721
|
/** The Job's unique ID
|
|
@@ -755,13 +761,14 @@ export interface JobApplication {
|
|
|
755
761
|
* 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)
|
|
756
762
|
|
|
757
763
|
*/
|
|
758
|
-
export type InstanceSummaryJobImageType =
|
|
764
|
+
export type InstanceSummaryJobImageType =
|
|
765
|
+
typeof InstanceSummaryJobImageType[keyof typeof InstanceSummaryJobImageType];
|
|
759
766
|
|
|
760
767
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
761
768
|
export const InstanceSummaryJobImageType = {
|
|
762
|
-
SIMPLE: "SIMPLE"
|
|
763
|
-
NEXTFLOW: "NEXTFLOW"
|
|
764
|
-
};
|
|
769
|
+
SIMPLE: "SIMPLE",
|
|
770
|
+
NEXTFLOW: "NEXTFLOW",
|
|
771
|
+
} as const;
|
|
765
772
|
|
|
766
773
|
/**
|
|
767
774
|
* The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
|
|
@@ -769,38 +776,32 @@ The initial phase, indicating that the Instance is preparring to run, is `PENDIN
|
|
|
769
776
|
|
|
770
777
|
*/
|
|
771
778
|
export type InstanceSummaryPhase =
|
|
772
|
-
|
|
773
|
-
| "CRASH_LOOP_BACKOFF"
|
|
774
|
-
| "FAILED"
|
|
775
|
-
| "IMAGE_PULL_BACKOFF"
|
|
776
|
-
| "PENDING"
|
|
777
|
-
| "RUNNING"
|
|
778
|
-
| "SUCCEEDED"
|
|
779
|
-
| "UNKNOWN";
|
|
779
|
+
typeof InstanceSummaryPhase[keyof typeof InstanceSummaryPhase];
|
|
780
780
|
|
|
781
781
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
782
782
|
export const InstanceSummaryPhase = {
|
|
783
|
-
COMPLETED: "COMPLETED"
|
|
784
|
-
CRASH_LOOP_BACKOFF: "CRASH_LOOP_BACKOFF"
|
|
785
|
-
FAILED: "FAILED"
|
|
786
|
-
IMAGE_PULL_BACKOFF: "IMAGE_PULL_BACKOFF"
|
|
787
|
-
PENDING: "PENDING"
|
|
788
|
-
RUNNING: "RUNNING"
|
|
789
|
-
SUCCEEDED: "SUCCEEDED"
|
|
790
|
-
UNKNOWN: "UNKNOWN"
|
|
791
|
-
};
|
|
783
|
+
COMPLETED: "COMPLETED",
|
|
784
|
+
CRASH_LOOP_BACKOFF: "CRASH_LOOP_BACKOFF",
|
|
785
|
+
FAILED: "FAILED",
|
|
786
|
+
IMAGE_PULL_BACKOFF: "IMAGE_PULL_BACKOFF",
|
|
787
|
+
PENDING: "PENDING",
|
|
788
|
+
RUNNING: "RUNNING",
|
|
789
|
+
SUCCEEDED: "SUCCEEDED",
|
|
790
|
+
UNKNOWN: "UNKNOWN",
|
|
791
|
+
} as const;
|
|
792
792
|
|
|
793
793
|
/**
|
|
794
794
|
* The type of Application, which can be a `job` or an `application`
|
|
795
795
|
|
|
796
796
|
*/
|
|
797
|
-
export type InstanceSummaryApplicationType =
|
|
797
|
+
export type InstanceSummaryApplicationType =
|
|
798
|
+
typeof InstanceSummaryApplicationType[keyof typeof InstanceSummaryApplicationType];
|
|
798
799
|
|
|
799
800
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
800
801
|
export const InstanceSummaryApplicationType = {
|
|
801
|
-
APPLICATION: "APPLICATION"
|
|
802
|
-
JOB: "JOB"
|
|
803
|
-
};
|
|
802
|
+
APPLICATION: "APPLICATION",
|
|
803
|
+
JOB: "JOB",
|
|
804
|
+
} as const;
|
|
804
805
|
|
|
805
806
|
export interface InstanceSummary {
|
|
806
807
|
/** The application instance ID
|
|
@@ -914,22 +915,17 @@ export type DatasetVersionSummaryLabels = { [key: string]: any };
|
|
|
914
915
|
|
|
915
916
|
*/
|
|
916
917
|
export type DatasetVersionSummaryProcessingStage =
|
|
917
|
-
|
|
918
|
-
| "FAILED"
|
|
919
|
-
| "FORMATTING"
|
|
920
|
-
| "LOADING"
|
|
921
|
-
| "DELETING"
|
|
922
|
-
| "DONE";
|
|
918
|
+
typeof DatasetVersionSummaryProcessingStage[keyof typeof DatasetVersionSummaryProcessingStage];
|
|
923
919
|
|
|
924
920
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
925
921
|
export const DatasetVersionSummaryProcessingStage = {
|
|
926
|
-
COPYING: "COPYING"
|
|
927
|
-
FAILED: "FAILED"
|
|
928
|
-
FORMATTING: "FORMATTING"
|
|
929
|
-
LOADING: "LOADING"
|
|
930
|
-
DELETING: "DELETING"
|
|
931
|
-
DONE: "DONE"
|
|
932
|
-
};
|
|
922
|
+
COPYING: "COPYING",
|
|
923
|
+
FAILED: "FAILED",
|
|
924
|
+
FORMATTING: "FORMATTING",
|
|
925
|
+
LOADING: "LOADING",
|
|
926
|
+
DELETING: "DELETING",
|
|
927
|
+
DONE: "DONE",
|
|
928
|
+
} as const;
|
|
933
929
|
|
|
934
930
|
export interface DatasetVersionSummary {
|
|
935
931
|
/** The owner of the Dataset version
|
|
@@ -993,22 +989,17 @@ export type DatasetVersionDetailLabels = { [key: string]: any };
|
|
|
993
989
|
|
|
994
990
|
*/
|
|
995
991
|
export type DatasetVersionDetailProcessingStage =
|
|
996
|
-
|
|
997
|
-
| "FAILED"
|
|
998
|
-
| "FORMATTING"
|
|
999
|
-
| "LOADING"
|
|
1000
|
-
| "DELETING"
|
|
1001
|
-
| "DONE";
|
|
992
|
+
typeof DatasetVersionDetailProcessingStage[keyof typeof DatasetVersionDetailProcessingStage];
|
|
1002
993
|
|
|
1003
994
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
1004
995
|
export const DatasetVersionDetailProcessingStage = {
|
|
1005
|
-
COPYING: "COPYING"
|
|
1006
|
-
FAILED: "FAILED"
|
|
1007
|
-
FORMATTING: "FORMATTING"
|
|
1008
|
-
LOADING: "LOADING"
|
|
1009
|
-
DELETING: "DELETING"
|
|
1010
|
-
DONE: "DONE"
|
|
1011
|
-
};
|
|
996
|
+
COPYING: "COPYING",
|
|
997
|
+
FAILED: "FAILED",
|
|
998
|
+
FORMATTING: "FORMATTING",
|
|
999
|
+
LOADING: "LOADING",
|
|
1000
|
+
DELETING: "DELETING",
|
|
1001
|
+
DONE: "DONE",
|
|
1002
|
+
} as const;
|
|
1012
1003
|
|
|
1013
1004
|
export interface DatasetVersionDetail {
|
|
1014
1005
|
/** The owner of the Dataset version
|
|
@@ -1095,21 +1086,25 @@ export interface ApplicationSummary {
|
|
|
1095
1086
|
/** The application unique reference, the value of the Kubernetes **Custom Resource Definition** `metadata.name` property
|
|
1096
1087
|
*/
|
|
1097
1088
|
application_id: string;
|
|
1089
|
+
/** The application's latest version as declared in The **Custom Resource Definition**
|
|
1090
|
+
*/
|
|
1091
|
+
latest_version: string;
|
|
1098
1092
|
}
|
|
1099
1093
|
|
|
1100
1094
|
/**
|
|
1101
1095
|
* The REST method used. GET methods are not logged
|
|
1102
1096
|
|
|
1103
1097
|
*/
|
|
1104
|
-
export type ApiLogDetailMethod =
|
|
1098
|
+
export type ApiLogDetailMethod =
|
|
1099
|
+
typeof ApiLogDetailMethod[keyof typeof ApiLogDetailMethod];
|
|
1105
1100
|
|
|
1106
1101
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
1107
1102
|
export const ApiLogDetailMethod = {
|
|
1108
|
-
DELETE: "DELETE"
|
|
1109
|
-
PATCH: "PATCH"
|
|
1110
|
-
POST: "POST"
|
|
1111
|
-
PUT: "PUT"
|
|
1112
|
-
};
|
|
1103
|
+
DELETE: "DELETE",
|
|
1104
|
+
PATCH: "PATCH",
|
|
1105
|
+
POST: "POST",
|
|
1106
|
+
PUT: "PUT",
|
|
1107
|
+
} as const;
|
|
1113
1108
|
|
|
1114
1109
|
export interface ApiLogDetail {
|
|
1115
1110
|
/** The REST method used. GET methods are not logged
|
|
@@ -1175,18 +1170,15 @@ export interface TasksGetResponse {
|
|
|
1175
1170
|
|
|
1176
1171
|
*/
|
|
1177
1172
|
export type TaskGetResponsePurpose =
|
|
1178
|
-
|
|
1179
|
-
| "FILE"
|
|
1180
|
-
| "INSTANCE"
|
|
1181
|
-
| "PROJECT";
|
|
1173
|
+
typeof TaskGetResponsePurpose[keyof typeof TaskGetResponsePurpose];
|
|
1182
1174
|
|
|
1183
1175
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
1184
1176
|
export const TaskGetResponsePurpose = {
|
|
1185
|
-
DATASET: "DATASET"
|
|
1186
|
-
FILE: "FILE"
|
|
1187
|
-
INSTANCE: "INSTANCE"
|
|
1188
|
-
PROJECT: "PROJECT"
|
|
1189
|
-
};
|
|
1177
|
+
DATASET: "DATASET",
|
|
1178
|
+
FILE: "FILE",
|
|
1179
|
+
INSTANCE: "INSTANCE",
|
|
1180
|
+
PROJECT: "PROJECT",
|
|
1181
|
+
} as const;
|
|
1190
1182
|
|
|
1191
1183
|
export interface TaskGetResponse {
|
|
1192
1184
|
/** 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`)
|
|
@@ -1252,13 +1244,14 @@ export interface JobsGetResponse {
|
|
|
1252
1244
|
* 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)
|
|
1253
1245
|
|
|
1254
1246
|
*/
|
|
1255
|
-
export type JobGetResponseImageType =
|
|
1247
|
+
export type JobGetResponseImageType =
|
|
1248
|
+
typeof JobGetResponseImageType[keyof typeof JobGetResponseImageType];
|
|
1256
1249
|
|
|
1257
1250
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
1258
1251
|
export const JobGetResponseImageType = {
|
|
1259
|
-
SIMPLE: "SIMPLE"
|
|
1260
|
-
NEXTFLOW: "NEXTFLOW"
|
|
1261
|
-
};
|
|
1252
|
+
SIMPLE: "SIMPLE",
|
|
1253
|
+
NEXTFLOW: "NEXTFLOW",
|
|
1254
|
+
} as const;
|
|
1262
1255
|
|
|
1263
1256
|
export interface JobGetResponse {
|
|
1264
1257
|
/** The Job's unique ID
|
|
@@ -1313,13 +1306,14 @@ export interface JobGetResponse {
|
|
|
1313
1306
|
variables?: JobVariables;
|
|
1314
1307
|
}
|
|
1315
1308
|
|
|
1316
|
-
export type InstanceTaskPurpose =
|
|
1309
|
+
export type InstanceTaskPurpose =
|
|
1310
|
+
typeof InstanceTaskPurpose[keyof typeof InstanceTaskPurpose];
|
|
1317
1311
|
|
|
1318
1312
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
1319
1313
|
export const InstanceTaskPurpose = {
|
|
1320
|
-
CREATE: "CREATE"
|
|
1321
|
-
DELETE: "DELETE"
|
|
1322
|
-
};
|
|
1314
|
+
CREATE: "CREATE",
|
|
1315
|
+
DELETE: "DELETE",
|
|
1316
|
+
} as const;
|
|
1323
1317
|
|
|
1324
1318
|
export interface InstanceTask {
|
|
1325
1319
|
id: string;
|
|
@@ -1336,38 +1330,32 @@ The initial phase, indicating that the Instance is preparring to run, is `PENDIN
|
|
|
1336
1330
|
|
|
1337
1331
|
*/
|
|
1338
1332
|
export type InstanceGetResponsePhase =
|
|
1339
|
-
|
|
1340
|
-
| "CRASH_LOOP_BACKOFF"
|
|
1341
|
-
| "FAILED"
|
|
1342
|
-
| "IMAGE_PULL_BACKOFF"
|
|
1343
|
-
| "PENDING"
|
|
1344
|
-
| "RUNNING"
|
|
1345
|
-
| "SUCCEEDED"
|
|
1346
|
-
| "UNKNOWN";
|
|
1333
|
+
typeof InstanceGetResponsePhase[keyof typeof InstanceGetResponsePhase];
|
|
1347
1334
|
|
|
1348
1335
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
1349
1336
|
export const InstanceGetResponsePhase = {
|
|
1350
|
-
COMPLETED: "COMPLETED"
|
|
1351
|
-
CRASH_LOOP_BACKOFF: "CRASH_LOOP_BACKOFF"
|
|
1352
|
-
FAILED: "FAILED"
|
|
1353
|
-
IMAGE_PULL_BACKOFF: "IMAGE_PULL_BACKOFF"
|
|
1354
|
-
PENDING: "PENDING"
|
|
1355
|
-
RUNNING: "RUNNING"
|
|
1356
|
-
SUCCEEDED: "SUCCEEDED"
|
|
1357
|
-
UNKNOWN: "UNKNOWN"
|
|
1358
|
-
};
|
|
1337
|
+
COMPLETED: "COMPLETED",
|
|
1338
|
+
CRASH_LOOP_BACKOFF: "CRASH_LOOP_BACKOFF",
|
|
1339
|
+
FAILED: "FAILED",
|
|
1340
|
+
IMAGE_PULL_BACKOFF: "IMAGE_PULL_BACKOFF",
|
|
1341
|
+
PENDING: "PENDING",
|
|
1342
|
+
RUNNING: "RUNNING",
|
|
1343
|
+
SUCCEEDED: "SUCCEEDED",
|
|
1344
|
+
UNKNOWN: "UNKNOWN",
|
|
1345
|
+
} as const;
|
|
1359
1346
|
|
|
1360
1347
|
/**
|
|
1361
1348
|
* The type of Application, which can be a `job` or an `application`
|
|
1362
1349
|
|
|
1363
1350
|
*/
|
|
1364
|
-
export type InstanceGetResponseApplicationType =
|
|
1351
|
+
export type InstanceGetResponseApplicationType =
|
|
1352
|
+
typeof InstanceGetResponseApplicationType[keyof typeof InstanceGetResponseApplicationType];
|
|
1365
1353
|
|
|
1366
1354
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
1367
1355
|
export const InstanceGetResponseApplicationType = {
|
|
1368
|
-
APPLICATION: "APPLICATION"
|
|
1369
|
-
JOB: "JOB"
|
|
1370
|
-
};
|
|
1356
|
+
APPLICATION: "APPLICATION",
|
|
1357
|
+
JOB: "JOB",
|
|
1358
|
+
} as const;
|
|
1371
1359
|
|
|
1372
1360
|
export interface InstanceGetResponse {
|
|
1373
1361
|
/** The Project the Instance is running in
|
|
@@ -1394,9 +1382,12 @@ export interface InstanceGetResponse {
|
|
|
1394
1382
|
/** The application owner, the person who launched tha apllication and is the only user than can stop it.
|
|
1395
1383
|
*/
|
|
1396
1384
|
owner: string;
|
|
1397
|
-
/** The
|
|
1385
|
+
/** The date and time the instance was started, an ISO-8601 format string.
|
|
1398
1386
|
*/
|
|
1399
1387
|
launched: string;
|
|
1388
|
+
/** The date and time the instance stopped, an ISO-8601 format string.
|
|
1389
|
+
*/
|
|
1390
|
+
stopped?: string;
|
|
1400
1391
|
/** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
|
|
1401
1392
|
The initial phase, indicating that the Instance is preparring 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 unsuccesfully.
|
|
1402
1393
|
*/
|
|
@@ -1413,6 +1404,9 @@ The initial phase, indicating that the Instance is preparring to run, is `PENDIN
|
|
|
1413
1404
|
/** A list of Tasks related to the application. Tasks are responsible for creating and deleteing the instance. You should fins at least one, assuming the corresponding task has not been deleted.
|
|
1414
1405
|
*/
|
|
1415
1406
|
tasks: InstanceTask[];
|
|
1407
|
+
/** Set if the instance hasa valid callback token. Instances with a valid token allow users to read files form the project without authentication
|
|
1408
|
+
*/
|
|
1409
|
+
has_valid_callback_token: boolean;
|
|
1416
1410
|
}
|
|
1417
1411
|
|
|
1418
1412
|
export interface FilesGetResponse {
|
|
@@ -1449,6 +1443,9 @@ export interface InstancePostResponse {
|
|
|
1449
1443
|
/** The application instance identity (not its name). Assigned automatically when created
|
|
1450
1444
|
*/
|
|
1451
1445
|
instance_id: string;
|
|
1446
|
+
/** 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.
|
|
1447
|
+
*/
|
|
1448
|
+
callback_token?: string;
|
|
1452
1449
|
/** The instance task identity. The task assigned to process the instance
|
|
1453
1450
|
*/
|
|
1454
1451
|
task_id: string;
|
|
@@ -1471,12 +1468,13 @@ export type DatasetVersionDeleteResponse = TaskIdentity;
|
|
|
1471
1468
|
* The Metadata type (an object)
|
|
1472
1469
|
|
|
1473
1470
|
*/
|
|
1474
|
-
export type DatasetSchemaGetResponseType =
|
|
1471
|
+
export type DatasetSchemaGetResponseType =
|
|
1472
|
+
typeof DatasetSchemaGetResponseType[keyof typeof DatasetSchemaGetResponseType];
|
|
1475
1473
|
|
|
1476
1474
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
1477
1475
|
export const DatasetSchemaGetResponseType = {
|
|
1478
|
-
object: "object"
|
|
1479
|
-
};
|
|
1476
|
+
object: "object",
|
|
1477
|
+
} as const;
|
|
1480
1478
|
|
|
1481
1479
|
export interface DatasetSchemaGetResponse {
|
|
1482
1480
|
/** The Metadata title
|