@squonk/data-manager-client 3.3.0 → 3.3.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.map +1 -1
- package/accounting/accounting.d.cts +25 -25
- package/accounting/accounting.d.ts +25 -25
- package/accounting/accounting.js.map +1 -1
- package/admin/admin.cjs +16 -8
- package/admin/admin.cjs.map +1 -1
- package/admin/admin.d.cts +73 -73
- package/admin/admin.d.ts +73 -73
- package/admin/admin.js +16 -8
- package/admin/admin.js.map +1 -1
- package/application/application.cjs +1 -1
- package/application/application.cjs.map +1 -1
- package/application/application.d.cts +17 -17
- package/application/application.d.ts +17 -17
- package/application/application.js +1 -1
- package/application/application.js.map +1 -1
- package/configuration/configuration.cjs.map +1 -1
- package/configuration/configuration.d.cts +9 -9
- package/configuration/configuration.d.ts +9 -9
- package/configuration/configuration.js.map +1 -1
- package/dataset/dataset.cjs +16 -10
- package/dataset/dataset.cjs.map +1 -1
- package/dataset/dataset.d.cts +64 -64
- package/dataset/dataset.d.ts +64 -64
- package/dataset/dataset.js +16 -10
- package/dataset/dataset.js.map +1 -1
- package/digest/digest.cjs +1 -1
- package/digest/digest.cjs.map +1 -1
- package/digest/digest.d.cts +9 -9
- package/digest/digest.d.ts +9 -9
- package/digest/digest.js +1 -1
- package/digest/digest.js.map +1 -1
- package/exchange-rate/exchange-rate.cjs +6 -4
- package/exchange-rate/exchange-rate.cjs.map +1 -1
- package/exchange-rate/exchange-rate.d.cts +45 -45
- package/exchange-rate/exchange-rate.d.ts +45 -45
- package/exchange-rate/exchange-rate.js +6 -4
- package/exchange-rate/exchange-rate.js.map +1 -1
- package/file-and-path/file-and-path.cjs +18 -10
- package/file-and-path/file-and-path.cjs.map +1 -1
- package/file-and-path/file-and-path.d.cts +60 -60
- package/file-and-path/file-and-path.d.ts +60 -60
- package/file-and-path/file-and-path.js +18 -10
- package/file-and-path/file-and-path.js.map +1 -1
- package/index.cjs +8 -8
- package/index.cjs.map +1 -1
- package/index.d.cts +537 -537
- package/index.d.ts +537 -537
- package/index.js +8 -8
- package/index.js.map +1 -1
- package/instance/instance.cjs +17 -10
- package/instance/instance.cjs.map +1 -1
- package/instance/instance.d.cts +49 -49
- package/instance/instance.d.ts +49 -49
- package/instance/instance.js +17 -10
- package/instance/instance.js.map +1 -1
- package/inventory/inventory.cjs.map +1 -1
- package/inventory/inventory.d.cts +9 -9
- package/inventory/inventory.d.ts +9 -9
- package/inventory/inventory.js.map +1 -1
- package/job/job.cjs +1 -1
- package/job/job.cjs.map +1 -1
- package/job/job.d.cts +25 -25
- package/job/job.d.ts +25 -25
- package/job/job.js +1 -1
- package/job/job.js.map +1 -1
- package/metadata/metadata.cjs +12 -8
- package/metadata/metadata.cjs.map +1 -1
- package/metadata/metadata.d.cts +31 -31
- package/metadata/metadata.d.ts +31 -31
- package/metadata/metadata.js +12 -8
- package/metadata/metadata.js.map +1 -1
- package/package.json +11 -11
- package/project/project.cjs +26 -15
- package/project/project.cjs.map +1 -1
- package/project/project.d.cts +94 -94
- package/project/project.d.ts +94 -94
- package/project/project.js +26 -15
- package/project/project.js.map +1 -1
- package/src/accounting/accounting.ts +38 -37
- package/src/admin/admin.ts +142 -101
- package/src/application/application.ts +26 -25
- package/src/configuration/configuration.ts +14 -13
- package/src/data-manager-api.schemas.ts +545 -545
- package/src/dataset/dataset.ts +118 -91
- package/src/digest/digest.ts +14 -13
- package/src/exchange-rate/exchange-rate.ts +76 -65
- package/src/file-and-path/file-and-path.ts +120 -83
- package/src/instance/instance.ts +97 -69
- package/src/inventory/inventory.ts +14 -13
- package/src/job/job.ts +38 -37
- package/src/metadata/metadata.ts +58 -45
- package/src/project/project.ts +183 -131
- package/src/task/task.ts +39 -33
- package/src/type/type.ts +14 -13
- package/src/user/user.ts +51 -45
- package/task/task.cjs +3 -2
- package/task/task.cjs.map +1 -1
- package/task/task.d.cts +23 -23
- package/task/task.d.ts +23 -23
- package/task/task.js +3 -2
- package/task/task.js.map +1 -1
- package/type/type.cjs.map +1 -1
- package/type/type.d.cts +9 -9
- package/type/type.d.ts +9 -9
- package/type/type.js.map +1 -1
- package/user/user.cjs +2 -1
- package/user/user.cjs.map +1 -1
- package/user/user.d.cts +31 -31
- package/user/user.d.ts +31 -31
- package/user/user.js +2 -1
- package/user/user.js.map +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// @ts-nocheck
|
|
2
2
|
/**
|
|
3
|
-
* Generated by orval v7.
|
|
3
|
+
* Generated by orval v7.4.1 🍺
|
|
4
4
|
* Do not edit manually.
|
|
5
5
|
* Dataset Manager API
|
|
6
6
|
* The Dataset Manager API service.
|
|
@@ -638,6 +638,9 @@ export type UserPatchBodyBody = {
|
|
|
638
638
|
};
|
|
639
639
|
|
|
640
640
|
export type UserAccountPatchBodyBody = {
|
|
641
|
+
/** If set the user account becomes private, if provided but false the user account becomes public. Public Users show up in user searches
|
|
642
|
+
*/
|
|
643
|
+
private?: boolean;
|
|
641
644
|
/** 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
|
|
642
645
|
*/
|
|
643
646
|
become_admin?: boolean;
|
|
@@ -648,9 +651,6 @@ export type UserAccountPatchBodyBody = {
|
|
|
648
651
|
* @pattern ^(\w(?:\w*(?:[@.-]\w+)?)*|)$
|
|
649
652
|
*/
|
|
650
653
|
impersonate?: string;
|
|
651
|
-
/** If set the user account becomes private, if provided but false the user account becomes public. Public Users show up in user searches
|
|
652
|
-
*/
|
|
653
|
-
private?: boolean;
|
|
654
654
|
/** 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`
|
|
655
655
|
*/
|
|
656
656
|
use_impersonation?: boolean;
|
|
@@ -674,13 +674,14 @@ export type ProjectPostBodyBody = {
|
|
|
674
674
|
};
|
|
675
675
|
|
|
676
676
|
export type ProjectPatchBodyBody = {
|
|
677
|
+
private?: boolean;
|
|
677
678
|
/** The new name of the ptojct
|
|
678
679
|
*/
|
|
679
680
|
name?: string;
|
|
680
|
-
private?: boolean;
|
|
681
681
|
};
|
|
682
682
|
|
|
683
683
|
export type ProjectFilePutBodyBody = {
|
|
684
|
+
file: Blob;
|
|
684
685
|
/**
|
|
685
686
|
* An alternative filename to use for the uploaded File
|
|
686
687
|
|
|
@@ -688,7 +689,6 @@ export type ProjectFilePutBodyBody = {
|
|
|
688
689
|
* @maxLength 128
|
|
689
690
|
*/
|
|
690
691
|
as_filename?: string;
|
|
691
|
-
file: Blob;
|
|
692
692
|
/**
|
|
693
693
|
* The Project path of the file.
|
|
694
694
|
|
|
@@ -700,18 +700,20 @@ export type ProjectFilePutBodyBody = {
|
|
|
700
700
|
};
|
|
701
701
|
|
|
702
702
|
export type ExchangeRatePutBodyBody = {
|
|
703
|
+
/** 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.
|
|
704
|
+
*/
|
|
705
|
+
rate: string;
|
|
703
706
|
/**
|
|
704
707
|
* A brief comment relating to the new rate
|
|
705
708
|
|
|
706
709
|
* @maxLength 80
|
|
707
710
|
*/
|
|
708
711
|
comment?: string;
|
|
709
|
-
/** 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.
|
|
710
|
-
*/
|
|
711
|
-
rate: string;
|
|
712
712
|
};
|
|
713
713
|
|
|
714
714
|
export type JobManifestPutBodyBody = {
|
|
715
|
+
/** The URL of the Job Manifest */
|
|
716
|
+
url: string;
|
|
715
717
|
/**
|
|
716
718
|
* Optional URL header values (a JSON string)
|
|
717
719
|
* @pattern ^|{.*}$
|
|
@@ -722,8 +724,6 @@ export type JobManifestPutBodyBody = {
|
|
|
722
724
|
* @pattern ^|{.*}$
|
|
723
725
|
*/
|
|
724
726
|
params?: string;
|
|
725
|
-
/** The URL of the Job Manifest */
|
|
726
|
-
url: string;
|
|
727
727
|
};
|
|
728
728
|
|
|
729
729
|
export type InstancePostBodyBody = {
|
|
@@ -736,6 +736,12 @@ Application IDs currently supported include `datamanagerjobs.squonk.it` and `jup
|
|
|
736
736
|
* @maxLength 80
|
|
737
737
|
*/
|
|
738
738
|
application_id: string;
|
|
739
|
+
/**
|
|
740
|
+
* The project to attach
|
|
741
|
+
|
|
742
|
+
* @pattern ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
|
|
743
|
+
*/
|
|
744
|
+
project_id: string;
|
|
739
745
|
/**
|
|
740
746
|
* The name to use for the instance
|
|
741
747
|
|
|
@@ -744,6 +750,9 @@ Application IDs currently supported include `datamanagerjobs.squonk.it` and `jup
|
|
|
744
750
|
* @pattern ^[A-Za-z0-9]+[A-Za-z0-9-_. ]*[A-Za-z0-9]+$
|
|
745
751
|
*/
|
|
746
752
|
as_name: string;
|
|
753
|
+
/** A URL the DM will use to PUT job progress messages as the requested instance runs. Used, at the moment, for Job execution
|
|
754
|
+
*/
|
|
755
|
+
callback_url?: string;
|
|
747
756
|
/**
|
|
748
757
|
* 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
|
|
749
758
|
|
|
@@ -751,6 +760,13 @@ Application IDs currently supported include `datamanagerjobs.squonk.it` and `jup
|
|
|
751
760
|
* @maxLength 256
|
|
752
761
|
*/
|
|
753
762
|
callback_context?: string;
|
|
763
|
+
/** 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.
|
|
764
|
+
|
|
765
|
+
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.
|
|
766
|
+
|
|
767
|
+
Tokens should therefore be revoked when they're no longer required
|
|
768
|
+
*/
|
|
769
|
+
generate_callback_token?: boolean;
|
|
754
770
|
/**
|
|
755
771
|
* 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.
|
|
756
772
|
|
|
@@ -761,9 +777,6 @@ See the Python module's `shortuuid.get_alphabet()` for the full list of permitte
|
|
|
761
777
|
* @pattern ^[2-9A-HJ-NP-Za-km-z]{22}$
|
|
762
778
|
*/
|
|
763
779
|
callback_token?: string;
|
|
764
|
-
/** A URL the DM will use to PUT job progress messages as the requested instance runs. Used, at the moment, for Job execution
|
|
765
|
-
*/
|
|
766
|
-
callback_url?: string;
|
|
767
780
|
/** A debug value that may be used by the instance.
|
|
768
781
|
|
|
769
782
|
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.
|
|
@@ -771,19 +784,6 @@ For Data Manager **Job** applications setting this to anything other zero ('0')
|
|
|
771
784
|
The behaviour of **Application** instances using this property is undefined. It will depend on whether the application **CRD** handles the Data Manager debug field.
|
|
772
785
|
*/
|
|
773
786
|
debug?: string;
|
|
774
|
-
/** 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.
|
|
775
|
-
|
|
776
|
-
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.
|
|
777
|
-
|
|
778
|
-
Tokens should therefore be revoked when they're no longer required
|
|
779
|
-
*/
|
|
780
|
-
generate_callback_token?: boolean;
|
|
781
|
-
/**
|
|
782
|
-
* The project to attach
|
|
783
|
-
|
|
784
|
-
* @pattern ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
|
|
785
|
-
*/
|
|
786
|
-
project_id: string;
|
|
787
787
|
/** The instance specification. A JSON string that's application-specific and controls the application's behaviour.
|
|
788
788
|
|
|
789
789
|
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":"coin-test","version":"1.0.0"}`
|
|
@@ -798,12 +798,6 @@ Applications also support `variables`. The Jupyter notebook application supports
|
|
|
798
798
|
};
|
|
799
799
|
|
|
800
800
|
export type FilePostBodyBody = {
|
|
801
|
-
/** The desired Dataset file type (a MIME type). Whether or not the chosen fileType is supported will depend on the Dataset
|
|
802
|
-
*/
|
|
803
|
-
as_type: string;
|
|
804
|
-
/** 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
|
|
805
|
-
*/
|
|
806
|
-
compress?: boolean;
|
|
807
801
|
/**
|
|
808
802
|
* The Dataset UUID for the File that you intend to attach
|
|
809
803
|
|
|
@@ -816,9 +810,15 @@ export type FilePostBodyBody = {
|
|
|
816
810
|
* @minimum 1
|
|
817
811
|
*/
|
|
818
812
|
dataset_version: number;
|
|
819
|
-
/**
|
|
813
|
+
/**
|
|
814
|
+
* The Project UUID you're attaching to
|
|
815
|
+
|
|
816
|
+
* @pattern ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
|
|
817
|
+
*/
|
|
818
|
+
project_id: string;
|
|
819
|
+
/** The desired Dataset file type (a MIME type). Whether or not the chosen fileType is supported will depend on the Dataset
|
|
820
820
|
*/
|
|
821
|
-
|
|
821
|
+
as_type: string;
|
|
822
822
|
/**
|
|
823
823
|
* A path within the Project to add the File, default is the project root ('/'), the mount-point within the application container. Paths must begin '/'
|
|
824
824
|
|
|
@@ -826,34 +826,30 @@ export type FilePostBodyBody = {
|
|
|
826
826
|
* @pattern ^/.+$|^/$
|
|
827
827
|
*/
|
|
828
828
|
path?: string;
|
|
829
|
-
/**
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
829
|
+
/** 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
|
|
830
|
+
*/
|
|
831
|
+
compress?: boolean;
|
|
832
|
+
/** Whether the Dataset File can be modified while in the Project. By default the File cannot be modified
|
|
833
|
+
*/
|
|
834
|
+
immutable?: boolean;
|
|
835
835
|
};
|
|
836
836
|
|
|
837
837
|
export type DatasetPutBodyBody = {
|
|
838
|
-
/**
|
|
839
|
-
* 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.
|
|
840
|
-
|
|
841
|
-
* @pattern ^(dataset-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|)$
|
|
842
|
-
*/
|
|
843
|
-
dataset_id?: string;
|
|
844
838
|
/** The MIME type of the Dataset
|
|
845
839
|
*/
|
|
846
840
|
dataset_type: string;
|
|
847
|
-
/**
|
|
848
|
-
* The file name of the file in the Project path to load as a new Dataset.
|
|
849
|
-
|
|
850
|
-
* @minLength 1
|
|
851
|
-
* @maxLength 128
|
|
852
|
-
*/
|
|
853
|
-
file_name: string;
|
|
854
841
|
/** 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.
|
|
855
842
|
*/
|
|
856
843
|
format_extra_variables?: string;
|
|
844
|
+
/** 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
|
|
845
|
+
*/
|
|
846
|
+
skip_molecule_load?: boolean;
|
|
847
|
+
/**
|
|
848
|
+
* The Project the file belongs to
|
|
849
|
+
|
|
850
|
+
* @pattern ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
|
|
851
|
+
*/
|
|
852
|
+
project_id: string;
|
|
857
853
|
/**
|
|
858
854
|
* The Project path of the file.
|
|
859
855
|
|
|
@@ -863,14 +859,18 @@ export type DatasetPutBodyBody = {
|
|
|
863
859
|
*/
|
|
864
860
|
path: string;
|
|
865
861
|
/**
|
|
866
|
-
* The
|
|
862
|
+
* The file name of the file in the Project path to load as a new Dataset.
|
|
867
863
|
|
|
868
|
-
* @
|
|
864
|
+
* @minLength 1
|
|
865
|
+
* @maxLength 128
|
|
869
866
|
*/
|
|
870
|
-
|
|
871
|
-
/**
|
|
872
|
-
|
|
873
|
-
|
|
867
|
+
file_name: string;
|
|
868
|
+
/**
|
|
869
|
+
* 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.
|
|
870
|
+
|
|
871
|
+
* @pattern ^(dataset-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|)$
|
|
872
|
+
*/
|
|
873
|
+
dataset_id?: string;
|
|
874
874
|
/**
|
|
875
875
|
* The Organisational Unit you want the Dataset to belong to. If not supplied the Project Unit is used
|
|
876
876
|
|
|
@@ -880,24 +880,34 @@ export type DatasetPutBodyBody = {
|
|
|
880
880
|
};
|
|
881
881
|
|
|
882
882
|
export type DatasetVersionMetaPostBodyBody = {
|
|
883
|
-
/** 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.
|
|
884
|
-
*/
|
|
885
|
-
annotations?: string;
|
|
886
883
|
/** JSON string containing a list of parameter changes to the metadata. Only the description is currently allowed.
|
|
887
884
|
*/
|
|
888
885
|
meta_properties?: string;
|
|
886
|
+
/** 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.
|
|
887
|
+
*/
|
|
888
|
+
annotations?: string;
|
|
889
889
|
};
|
|
890
890
|
|
|
891
891
|
export type DatasetMetaPostBodyBody = {
|
|
892
|
-
/** 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.
|
|
893
|
-
*/
|
|
894
|
-
labels?: string;
|
|
895
892
|
/** JSON string containing a list of parameter changes to the metadata. Only the description is currently allowed.
|
|
896
893
|
*/
|
|
897
894
|
meta_properties?: string;
|
|
895
|
+
/** 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.
|
|
896
|
+
*/
|
|
897
|
+
labels?: string;
|
|
898
898
|
};
|
|
899
899
|
|
|
900
900
|
export type DatasetPostBodyBody = {
|
|
901
|
+
dataset_file: Blob;
|
|
902
|
+
/** 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.
|
|
903
|
+
*/
|
|
904
|
+
dataset_type: string;
|
|
905
|
+
/** 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.
|
|
906
|
+
*/
|
|
907
|
+
format_extra_variables?: string;
|
|
908
|
+
/** 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
|
|
909
|
+
*/
|
|
910
|
+
skip_molecule_load?: boolean;
|
|
901
911
|
/**
|
|
902
912
|
* An optional new filename to use for the uploaded Dataset. The Dataset will be stored using this name.
|
|
903
913
|
|
|
@@ -905,22 +915,12 @@ export type DatasetPostBodyBody = {
|
|
|
905
915
|
* @maxLength 128
|
|
906
916
|
*/
|
|
907
917
|
as_filename?: string;
|
|
908
|
-
dataset_file: Blob;
|
|
909
918
|
/**
|
|
910
919
|
* 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.
|
|
911
920
|
|
|
912
921
|
* @pattern ^(dataset-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|)$
|
|
913
922
|
*/
|
|
914
923
|
dataset_id?: string;
|
|
915
|
-
/** 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.
|
|
916
|
-
*/
|
|
917
|
-
dataset_type: string;
|
|
918
|
-
/** 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.
|
|
919
|
-
*/
|
|
920
|
-
format_extra_variables?: string;
|
|
921
|
-
/** 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
|
|
922
|
-
*/
|
|
923
|
-
skip_molecule_load?: boolean;
|
|
924
924
|
/**
|
|
925
925
|
* The Organisational Unit you want the Dataset to belong to
|
|
926
926
|
|
|
@@ -930,20 +930,20 @@ export type DatasetPostBodyBody = {
|
|
|
930
930
|
};
|
|
931
931
|
|
|
932
932
|
export interface AsAdditionalDataProcessingCharge {
|
|
933
|
-
collateral_cpu_hours?: string;
|
|
934
|
-
collateral_pod_count?: number;
|
|
935
933
|
cost: string;
|
|
936
|
-
cost_scale_factor: string;
|
|
937
934
|
cost_to_coins_er: string;
|
|
938
|
-
|
|
935
|
+
cost_scale_factor: string;
|
|
939
936
|
instance_id: string;
|
|
940
937
|
instance_name: string;
|
|
938
|
+
started: string;
|
|
939
|
+
stopped?: string;
|
|
940
|
+
run_time?: string;
|
|
941
|
+
error_message?: string;
|
|
941
942
|
job_collection?: string;
|
|
942
943
|
job_job?: string;
|
|
943
944
|
job_version?: string;
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
stopped?: string;
|
|
945
|
+
collateral_pod_count?: number;
|
|
946
|
+
collateral_cpu_hours?: string;
|
|
947
947
|
}
|
|
948
948
|
|
|
949
949
|
export interface UserSummary {
|
|
@@ -953,18 +953,15 @@ export interface UserSummary {
|
|
|
953
953
|
}
|
|
954
954
|
|
|
955
955
|
export interface UserDetail {
|
|
956
|
-
/**
|
|
956
|
+
/** The user's preferred username
|
|
957
957
|
*/
|
|
958
|
-
|
|
958
|
+
username: string;
|
|
959
959
|
/** The user's filesystem user uid
|
|
960
960
|
*/
|
|
961
961
|
f_uid?: number;
|
|
962
962
|
/** The date and time the user was first seen (an ISO-8601 formatted string in UTC)
|
|
963
963
|
*/
|
|
964
964
|
first_seen?: string;
|
|
965
|
-
/** For admin accounts, whether the user is impersonating another user
|
|
966
|
-
*/
|
|
967
|
-
impersonate?: string;
|
|
968
965
|
/** The date the user was last seen
|
|
969
966
|
*/
|
|
970
967
|
last_seen_date?: string;
|
|
@@ -977,17 +974,20 @@ export interface UserDetail {
|
|
|
977
974
|
/** If the account is suspended this typically displays a reason for suspension
|
|
978
975
|
*/
|
|
979
976
|
suspension_message?: string;
|
|
980
|
-
/**
|
|
977
|
+
/** For admin accounts, whether the user is acting in an administrative capacity, i.e. acting as everyone
|
|
981
978
|
*/
|
|
982
|
-
|
|
979
|
+
become_admin?: boolean;
|
|
980
|
+
/** For admin accounts, whether the user is impersonating another user
|
|
981
|
+
*/
|
|
982
|
+
impersonate?: string;
|
|
983
983
|
}
|
|
984
984
|
|
|
985
985
|
export interface UserAccountDetail {
|
|
986
|
+
user: UserDetail;
|
|
986
987
|
/** Whether the caller has admin privilege */
|
|
987
988
|
caller_has_admin_privilege: boolean;
|
|
988
989
|
/** The Data Manager roles the user has */
|
|
989
990
|
data_manager_roles: string[];
|
|
990
|
-
user: UserDetail;
|
|
991
991
|
}
|
|
992
992
|
|
|
993
993
|
/**
|
|
@@ -1007,34 +1007,34 @@ export const TypeSummaryFormatterOptionsType = {
|
|
|
1007
1007
|
|
|
1008
1008
|
*/
|
|
1009
1009
|
export type TypeSummaryFormatterOptions = {
|
|
1010
|
-
/** Required properties
|
|
1011
|
-
*/
|
|
1012
|
-
required: string[];
|
|
1013
1010
|
/** The title of the Formatter object
|
|
1014
1011
|
*/
|
|
1015
1012
|
title: string;
|
|
1016
1013
|
/** The Schema type (an object)
|
|
1017
1014
|
*/
|
|
1018
1015
|
type: TypeSummaryFormatterOptionsType;
|
|
1016
|
+
/** Required properties
|
|
1017
|
+
*/
|
|
1018
|
+
required: string[];
|
|
1019
1019
|
[key: string]: unknown;
|
|
1020
1020
|
};
|
|
1021
1021
|
|
|
1022
1022
|
export interface TypeSummary {
|
|
1023
|
+
/** The File Type MIME
|
|
1024
|
+
*/
|
|
1025
|
+
mime: string;
|
|
1023
1026
|
/** 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`).
|
|
1024
1027
|
*/
|
|
1025
1028
|
file_extensions: string[];
|
|
1026
1029
|
/** 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.
|
|
1027
1030
|
*/
|
|
1028
1031
|
formatter_image?: string;
|
|
1029
|
-
/** If present, contains the formatter_options that can be entered in the format_extra_variables field in the POST /dataset api.
|
|
1030
|
-
*/
|
|
1031
|
-
formatter_options?: TypeSummaryFormatterOptions;
|
|
1032
1032
|
/** True if Datasets uploaded using this type's support loading of data into the Data Manager data-base.
|
|
1033
1033
|
*/
|
|
1034
1034
|
formatter_supports_db_load?: boolean;
|
|
1035
|
-
/**
|
|
1035
|
+
/** If present, contains the formatter_options that can be entered in the format_extra_variables field in the POST /dataset api.
|
|
1036
1036
|
*/
|
|
1037
|
-
|
|
1037
|
+
formatter_options?: TypeSummaryFormatterOptions;
|
|
1038
1038
|
}
|
|
1039
1039
|
|
|
1040
1040
|
/**
|
|
@@ -1055,24 +1055,24 @@ export const TaskSummaryProcessingStage = {
|
|
|
1055
1055
|
} as const;
|
|
1056
1056
|
|
|
1057
1057
|
export interface TaskSummary {
|
|
1058
|
+
/** The Task UUID
|
|
1059
|
+
*/
|
|
1060
|
+
id: string;
|
|
1061
|
+
/** If a container image is launched by the task the image name is available here
|
|
1062
|
+
*/
|
|
1063
|
+
image?: string;
|
|
1058
1064
|
/** The date and time the task was created
|
|
1059
1065
|
*/
|
|
1060
1066
|
created: string;
|
|
1061
1067
|
/** True if the task has run to completion. If the task finished successfully the `exit_code` will be zero.
|
|
1062
1068
|
*/
|
|
1063
1069
|
done: boolean;
|
|
1070
|
+
/** True if the Task relates to an object removal, i.e. a DELETE
|
|
1071
|
+
*/
|
|
1072
|
+
removal?: boolean;
|
|
1064
1073
|
/** Present when `done` and zero if the task finished successfully.
|
|
1065
1074
|
*/
|
|
1066
1075
|
exit_code?: number;
|
|
1067
|
-
/** The Task UUID
|
|
1068
|
-
*/
|
|
1069
|
-
id: string;
|
|
1070
|
-
/** If a container image is launched by the task the image name is available here
|
|
1071
|
-
*/
|
|
1072
|
-
image?: string;
|
|
1073
|
-
/** 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
|
|
1074
|
-
*/
|
|
1075
|
-
processing_stage?: TaskSummaryProcessingStage;
|
|
1076
1076
|
/** 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_.
|
|
1077
1077
|
*/
|
|
1078
1078
|
purpose: string;
|
|
@@ -1082,9 +1082,9 @@ export interface TaskSummary {
|
|
|
1082
1082
|
/** The related object version for the Task purpose. This field will only be set if the **purpose** is `DATASET`.
|
|
1083
1083
|
*/
|
|
1084
1084
|
purpose_version?: number;
|
|
1085
|
-
/**
|
|
1085
|
+
/** 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
|
|
1086
1086
|
*/
|
|
1087
|
-
|
|
1087
|
+
processing_stage?: TaskSummaryProcessingStage;
|
|
1088
1088
|
}
|
|
1089
1089
|
|
|
1090
1090
|
/**
|
|
@@ -1104,12 +1104,12 @@ export const TaskStateState = {
|
|
|
1104
1104
|
} as const;
|
|
1105
1105
|
|
|
1106
1106
|
export interface TaskState {
|
|
1107
|
-
/** A short message accompanying the state, generally only found when the state is `FAILURE`
|
|
1108
|
-
*/
|
|
1109
|
-
message?: string;
|
|
1110
1107
|
/** The task state. The typical state sequence is `PENDING`, then `STARTED` and finally `SUCCESS`
|
|
1111
1108
|
*/
|
|
1112
1109
|
state: TaskStateState;
|
|
1110
|
+
/** A short message accompanying the state, generally only found when the state is `FAILURE`
|
|
1111
|
+
*/
|
|
1112
|
+
message?: string;
|
|
1113
1113
|
/** The date and time of the state change
|
|
1114
1114
|
*/
|
|
1115
1115
|
time: string;
|
|
@@ -1136,15 +1136,15 @@ export const TaskEventLevel = {
|
|
|
1136
1136
|
} as const;
|
|
1137
1137
|
|
|
1138
1138
|
export interface TaskEvent {
|
|
1139
|
-
/** The
|
|
1139
|
+
/** The event sequence number. The first event is always '1'.
|
|
1140
1140
|
*/
|
|
1141
|
-
|
|
1141
|
+
ordinal: number;
|
|
1142
1142
|
/** A short message.
|
|
1143
1143
|
*/
|
|
1144
1144
|
message: string;
|
|
1145
|
-
/** The
|
|
1145
|
+
/** The level of the message, a typical logging framework value
|
|
1146
1146
|
*/
|
|
1147
|
-
|
|
1147
|
+
level: TaskEventLevel;
|
|
1148
1148
|
/** The date and time the event was generated
|
|
1149
1149
|
*/
|
|
1150
1150
|
time: string;
|
|
@@ -1161,16 +1161,16 @@ export const ServiceErrorSummarySeverity = {
|
|
|
1161
1161
|
} as const;
|
|
1162
1162
|
|
|
1163
1163
|
export interface ServiceErrorSummary {
|
|
1164
|
-
acknowledged: boolean;
|
|
1165
|
-
acknowledged_at?: string;
|
|
1166
|
-
acknowledging_user?: string;
|
|
1167
|
-
created: string;
|
|
1168
|
-
error_code?: number;
|
|
1169
|
-
hostname: string;
|
|
1170
1164
|
id: number;
|
|
1165
|
+
created: string;
|
|
1166
|
+
summary: string;
|
|
1171
1167
|
severity: ServiceErrorSummarySeverity;
|
|
1168
|
+
hostname: string;
|
|
1169
|
+
error_code?: number;
|
|
1172
1170
|
stack_trace: string;
|
|
1173
|
-
|
|
1171
|
+
acknowledged: boolean;
|
|
1172
|
+
acknowledged_at?: string;
|
|
1173
|
+
acknowledging_user?: string;
|
|
1174
1174
|
}
|
|
1175
1175
|
|
|
1176
1176
|
export interface ProjectFileDetail {
|
|
@@ -1195,51 +1195,51 @@ export interface ProjectFileDetail {
|
|
|
1195
1195
|
/** True if the ProjectFile cannot be modified while in the Project
|
|
1196
1196
|
*/
|
|
1197
1197
|
immutable: boolean;
|
|
1198
|
-
/** The ProjectFile MIME type
|
|
1199
|
-
*/
|
|
1200
|
-
mime_type: string;
|
|
1201
1198
|
/** The owner of the ProjectFile. This is the user that added the Dataset (as this file) to the Project
|
|
1202
1199
|
*/
|
|
1203
1200
|
owner: string;
|
|
1204
1201
|
/** The Project the ProjectFile belongs to
|
|
1205
1202
|
*/
|
|
1206
1203
|
project_id?: string;
|
|
1204
|
+
/** The ProjectFile MIME type
|
|
1205
|
+
*/
|
|
1206
|
+
mime_type: string;
|
|
1207
1207
|
}
|
|
1208
1208
|
|
|
1209
1209
|
export interface ProjectDetail {
|
|
1210
|
-
/** An administrator (user_id) of the project */
|
|
1211
|
-
administrators: string[];
|
|
1212
|
-
created: string;
|
|
1213
|
-
/** The user who created the project
|
|
1214
|
-
*/
|
|
1215
|
-
creator: string;
|
|
1216
|
-
/** An editor (user_id) of the project */
|
|
1217
|
-
editors: string[];
|
|
1218
|
-
/** A list of managed files in the Project
|
|
1219
|
-
*/
|
|
1220
|
-
files?: ProjectFileDetail[];
|
|
1221
1210
|
/** The project name
|
|
1222
1211
|
*/
|
|
1223
1212
|
name: string;
|
|
1224
|
-
/**
|
|
1225
|
-
observers: string[];
|
|
1226
|
-
/** The Account Server Organisation the Project Product Unit belongs to
|
|
1213
|
+
/** The project unique reference
|
|
1227
1214
|
*/
|
|
1228
|
-
|
|
1229
|
-
/**
|
|
1215
|
+
project_id: string;
|
|
1216
|
+
/** The user who created the project
|
|
1230
1217
|
*/
|
|
1231
|
-
|
|
1218
|
+
creator: string;
|
|
1219
|
+
created: string;
|
|
1232
1220
|
/** The Account Server Product the Project belongs to
|
|
1233
1221
|
*/
|
|
1234
1222
|
product_id?: string;
|
|
1235
|
-
/** The
|
|
1223
|
+
/** The Account Server Organisation the Project Product Unit belongs to
|
|
1236
1224
|
*/
|
|
1237
|
-
|
|
1238
|
-
/** 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 */
|
|
1239
|
-
size: number;
|
|
1225
|
+
organisation_id?: string;
|
|
1240
1226
|
/** The Account Server Unit the Project Product belongs to
|
|
1241
1227
|
*/
|
|
1242
1228
|
unit_id?: string;
|
|
1229
|
+
/** True if the project is private. Private projects are only visible to editors.
|
|
1230
|
+
*/
|
|
1231
|
+
private: boolean;
|
|
1232
|
+
/** An administrator (user_id) of the project */
|
|
1233
|
+
administrators: string[];
|
|
1234
|
+
/** An editor (user_id) of the project */
|
|
1235
|
+
editors: string[];
|
|
1236
|
+
/** An observer (user_id) of the project */
|
|
1237
|
+
observers: string[];
|
|
1238
|
+
/** 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 */
|
|
1239
|
+
size: number;
|
|
1240
|
+
/** A list of managed files in the Project
|
|
1241
|
+
*/
|
|
1242
|
+
files?: ProjectFileDetail[];
|
|
1243
1243
|
}
|
|
1244
1244
|
|
|
1245
1245
|
export interface JobReplacement {
|
|
@@ -1258,16 +1258,16 @@ export interface JobOrderDetail {
|
|
|
1258
1258
|
}
|
|
1259
1259
|
|
|
1260
1260
|
/**
|
|
1261
|
-
* The Job command's
|
|
1261
|
+
* The Job command's options. The JSONSchema for the command's options, essentially the **variables/options** block of the Job's JobDefinition.
|
|
1262
1262
|
|
|
1263
1263
|
*/
|
|
1264
|
-
export type
|
|
1264
|
+
export type JobVariablesOptions = { [key: string]: unknown };
|
|
1265
1265
|
|
|
1266
1266
|
/**
|
|
1267
|
-
* The Job command's
|
|
1267
|
+
* The Job command's outputs. The JSONSchema for the command's inputs, essentially the **variables/outputs** block of the Job's JobDefinition.
|
|
1268
1268
|
|
|
1269
1269
|
*/
|
|
1270
|
-
export type
|
|
1270
|
+
export type JobVariablesOutputs = { [key: string]: unknown };
|
|
1271
1271
|
|
|
1272
1272
|
/**
|
|
1273
1273
|
* The Job command's inputs. The JSONSchema for the command's inputs, essentially the **variables/inputs** block of the Job's JobDefinition.
|
|
@@ -1276,16 +1276,16 @@ export type JobVariablesOptions = { [key: string]: unknown };
|
|
|
1276
1276
|
export type JobVariablesInputs = { [key: string]: unknown };
|
|
1277
1277
|
|
|
1278
1278
|
export interface JobVariables {
|
|
1279
|
+
order?: JobOrderDetail;
|
|
1279
1280
|
/** The Job command's inputs. The JSONSchema for the command's inputs, essentially the **variables/inputs** block of the Job's JobDefinition.
|
|
1280
1281
|
*/
|
|
1281
1282
|
inputs?: JobVariablesInputs;
|
|
1282
|
-
/** The Job command's options. The JSONSchema for the command's options, essentially the **variables/options** block of the Job's JobDefinition.
|
|
1283
|
-
*/
|
|
1284
|
-
options?: JobVariablesOptions;
|
|
1285
|
-
order?: JobOrderDetail;
|
|
1286
1283
|
/** The Job command's outputs. The JSONSchema for the command's inputs, essentially the **variables/outputs** block of the Job's JobDefinition.
|
|
1287
1284
|
*/
|
|
1288
1285
|
outputs?: JobVariablesOutputs;
|
|
1286
|
+
/** The Job command's options. The JSONSchema for the command's options, essentially the **variables/options** block of the Job's JobDefinition.
|
|
1287
|
+
*/
|
|
1288
|
+
options?: JobVariablesOptions;
|
|
1289
1289
|
}
|
|
1290
1290
|
|
|
1291
1291
|
/**
|
|
@@ -1302,84 +1302,84 @@ export const JobSummaryImageType = {
|
|
|
1302
1302
|
} as const;
|
|
1303
1303
|
|
|
1304
1304
|
export interface JobSummary {
|
|
1305
|
-
/** The Job's
|
|
1305
|
+
/** The Job's unique ID
|
|
1306
1306
|
*/
|
|
1307
|
-
|
|
1307
|
+
id: number;
|
|
1308
1308
|
/** The Job namespace
|
|
1309
1309
|
*/
|
|
1310
1310
|
collection: string;
|
|
1311
|
-
/** The
|
|
1312
|
-
*/
|
|
1313
|
-
description?: string;
|
|
1314
|
-
/** True if disabled. Disabled Jobs cannot be executed. If disabled a reason will be found in `disabled_reason`
|
|
1315
|
-
*/
|
|
1316
|
-
disabled: boolean;
|
|
1317
|
-
/** A reason why the Job has been disabled.
|
|
1318
|
-
*/
|
|
1319
|
-
disabled_reason?: string;
|
|
1320
|
-
/** 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).
|
|
1321
|
-
|
|
1322
|
-
Where there is no remedy for a given reason the remedy will be "There is no remedy".
|
|
1323
|
-
*/
|
|
1324
|
-
disabled_remedy?: string;
|
|
1325
|
-
/** A URL linking to the Job documentation
|
|
1311
|
+
/** The Job name, unique within a given namespace
|
|
1326
1312
|
*/
|
|
1327
|
-
|
|
1328
|
-
/** The Job
|
|
1313
|
+
job: string;
|
|
1314
|
+
/** The Job version
|
|
1329
1315
|
*/
|
|
1330
|
-
|
|
1316
|
+
version: string;
|
|
1331
1317
|
/** 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)
|
|
1332
1318
|
*/
|
|
1333
1319
|
image_type: JobSummaryImageType;
|
|
1334
|
-
/** The Job
|
|
1320
|
+
/** The Job's category
|
|
1335
1321
|
*/
|
|
1336
|
-
|
|
1322
|
+
category?: string;
|
|
1337
1323
|
/** The list of keywords assigned to the Job
|
|
1338
1324
|
*/
|
|
1339
1325
|
keywords?: string[];
|
|
1340
|
-
/** 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.
|
|
1341
|
-
*/
|
|
1342
|
-
missing_assets?: string[];
|
|
1343
1326
|
/** The name of the job in English
|
|
1344
1327
|
*/
|
|
1345
1328
|
name: string;
|
|
1346
|
-
|
|
1347
|
-
|
|
1329
|
+
/** The description of the job in English
|
|
1330
|
+
*/
|
|
1331
|
+
description?: string;
|
|
1332
|
+
/** A URL linking to the Job documentation
|
|
1333
|
+
*/
|
|
1334
|
+
doc_url?: string;
|
|
1348
1335
|
/** A list of Account Server assets names required to run the Job. You need access to these assets in order to run the Job
|
|
1349
1336
|
*/
|
|
1350
1337
|
required_assets: string[];
|
|
1351
|
-
/**
|
|
1338
|
+
/** 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.
|
|
1352
1339
|
*/
|
|
1353
|
-
|
|
1340
|
+
missing_assets?: string[];
|
|
1341
|
+
/** True if disabled. Disabled Jobs cannot be executed. If disabled a reason will be found in `disabled_reason`
|
|
1342
|
+
*/
|
|
1343
|
+
disabled: boolean;
|
|
1344
|
+
/** A reason why the Job has been disabled.
|
|
1345
|
+
*/
|
|
1346
|
+
disabled_reason?: string;
|
|
1347
|
+
/** 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).
|
|
1348
|
+
|
|
1349
|
+
Where there is no remedy for a given reason the remedy will be "There is no remedy".
|
|
1350
|
+
*/
|
|
1351
|
+
disabled_remedy?: string;
|
|
1352
|
+
replaces?: JobReplacements;
|
|
1353
|
+
replaced_by?: JobReplacements;
|
|
1354
1354
|
}
|
|
1355
1355
|
|
|
1356
1356
|
export interface JobManifestDetail {
|
|
1357
|
+
/** The Job Manifest record ID */
|
|
1358
|
+
id: number;
|
|
1359
|
+
url: string;
|
|
1360
|
+
header?: string;
|
|
1361
|
+
params?: string;
|
|
1357
1362
|
/** The Date (and time) the manifest was created
|
|
1358
1363
|
*/
|
|
1359
1364
|
created: string;
|
|
1360
1365
|
/** The (admin) user who created the manifest
|
|
1361
1366
|
*/
|
|
1362
1367
|
creator?: string;
|
|
1363
|
-
header?: string;
|
|
1364
|
-
/** The Job Manifest record ID */
|
|
1365
|
-
id: number;
|
|
1366
1368
|
/** The number of job definition files loaded during the most recent successful load
|
|
1367
1369
|
*/
|
|
1368
1370
|
job_definition_files_loaded?: number;
|
|
1369
1371
|
/** The number of job definitions loaded during the most recent successful load
|
|
1370
1372
|
*/
|
|
1371
1373
|
job_definitions_loaded?: number;
|
|
1372
|
-
/** The
|
|
1374
|
+
/** The Date (and time) the manifest was last loaded successfully
|
|
1373
1375
|
*/
|
|
1374
|
-
|
|
1376
|
+
last_successful_load_time?: string;
|
|
1375
1377
|
/** 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
|
|
1376
1378
|
*/
|
|
1377
1379
|
last_load_time?: string;
|
|
1378
|
-
/** The
|
|
1380
|
+
/** 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`
|
|
1379
1381
|
*/
|
|
1380
|
-
|
|
1381
|
-
params?: string;
|
|
1382
|
-
url: string;
|
|
1382
|
+
last_load_status: string;
|
|
1383
1383
|
}
|
|
1384
1384
|
|
|
1385
1385
|
export interface JobApplication {
|
|
@@ -1389,6 +1389,19 @@ export interface JobApplication {
|
|
|
1389
1389
|
version: string;
|
|
1390
1390
|
}
|
|
1391
1391
|
|
|
1392
|
+
/**
|
|
1393
|
+
* 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)
|
|
1394
|
+
|
|
1395
|
+
*/
|
|
1396
|
+
export type InstanceSummaryJobImageType = typeof InstanceSummaryJobImageType[keyof typeof InstanceSummaryJobImageType];
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
1400
|
+
export const InstanceSummaryJobImageType = {
|
|
1401
|
+
SIMPLE: 'SIMPLE',
|
|
1402
|
+
NEXTFLOW: 'NEXTFLOW',
|
|
1403
|
+
} as const;
|
|
1404
|
+
|
|
1392
1405
|
/**
|
|
1393
1406
|
* The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
|
|
1394
1407
|
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.
|
|
@@ -1409,19 +1422,6 @@ export const InstanceSummaryPhase = {
|
|
|
1409
1422
|
UNKNOWN: 'UNKNOWN',
|
|
1410
1423
|
} as const;
|
|
1411
1424
|
|
|
1412
|
-
/**
|
|
1413
|
-
* 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)
|
|
1414
|
-
|
|
1415
|
-
*/
|
|
1416
|
-
export type InstanceSummaryJobImageType = typeof InstanceSummaryJobImageType[keyof typeof InstanceSummaryJobImageType];
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
1420
|
-
export const InstanceSummaryJobImageType = {
|
|
1421
|
-
SIMPLE: 'SIMPLE',
|
|
1422
|
-
NEXTFLOW: 'NEXTFLOW',
|
|
1423
|
-
} as const;
|
|
1424
|
-
|
|
1425
1425
|
/**
|
|
1426
1426
|
* The type of Application, which can be a `job` or an `application`
|
|
1427
1427
|
|
|
@@ -1436,112 +1436,109 @@ export const InstanceSummaryApplicationType = {
|
|
|
1436
1436
|
} as const;
|
|
1437
1437
|
|
|
1438
1438
|
export interface InstanceSummary {
|
|
1439
|
+
/** The application instance ID
|
|
1440
|
+
*/
|
|
1441
|
+
id: string;
|
|
1442
|
+
/** True if the instance is archived (protected from automatic deletion)
|
|
1443
|
+
*/
|
|
1444
|
+
archived: boolean;
|
|
1439
1445
|
/** The application ID
|
|
1440
1446
|
*/
|
|
1441
1447
|
application_id: string;
|
|
1448
|
+
/** The application version
|
|
1449
|
+
*/
|
|
1450
|
+
application_version: string;
|
|
1442
1451
|
/** The User's specification, provided when the application was launched
|
|
1443
1452
|
*/
|
|
1444
1453
|
application_specification?: string;
|
|
1445
1454
|
/** The type of Application, which can be a `job` or an `application`
|
|
1446
1455
|
*/
|
|
1447
1456
|
application_type: InstanceSummaryApplicationType;
|
|
1448
|
-
/** The application version
|
|
1449
|
-
*/
|
|
1450
|
-
application_version: string;
|
|
1451
|
-
/** True if the instance is archived (protected from automatic deletion)
|
|
1452
|
-
*/
|
|
1453
|
-
archived: boolean;
|
|
1454
1457
|
/** The code obtained from the Account Server
|
|
1455
1458
|
*/
|
|
1456
1459
|
authorisation_code?: number;
|
|
1457
|
-
/** The
|
|
1460
|
+
/** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
|
|
1461
|
+
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.
|
|
1458
1462
|
*/
|
|
1459
|
-
|
|
1460
|
-
/**
|
|
1463
|
+
phase: InstanceSummaryPhase;
|
|
1464
|
+
/** The data and time (UTC) the instance was launched
|
|
1461
1465
|
*/
|
|
1462
|
-
|
|
1463
|
-
/**
|
|
1466
|
+
launched: string;
|
|
1467
|
+
/** The data and time (UTC) the instance started running
|
|
1464
1468
|
*/
|
|
1465
|
-
|
|
1466
|
-
/** The
|
|
1469
|
+
started?: string;
|
|
1470
|
+
/** The data and time (UTC) the instance stopped running
|
|
1467
1471
|
*/
|
|
1468
|
-
|
|
1469
|
-
/**
|
|
1472
|
+
stopped?: string;
|
|
1473
|
+
/** 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.
|
|
1470
1474
|
*/
|
|
1471
|
-
|
|
1472
|
-
/** The
|
|
1475
|
+
run_time: string;
|
|
1476
|
+
/** The application instance owner, the person who launched the application and is the only user than can stop it.
|
|
1473
1477
|
*/
|
|
1474
|
-
|
|
1475
|
-
/** The
|
|
1478
|
+
owner: string;
|
|
1479
|
+
/** The Project the instances is running in.
|
|
1476
1480
|
*/
|
|
1477
|
-
|
|
1481
|
+
project_id: string;
|
|
1482
|
+
/** The Instance name
|
|
1483
|
+
*/
|
|
1484
|
+
name: string;
|
|
1485
|
+
/** For applications (not Jobs) this is the URL the application has exposed. It will only be available when the application has started.
|
|
1486
|
+
*/
|
|
1487
|
+
url?: string;
|
|
1488
|
+
/** If the instance relates to a job, this will be the job collection, as defined in the original collection's job definition.
|
|
1489
|
+
*/
|
|
1490
|
+
job_collection?: string;
|
|
1478
1491
|
/** If the instance relates to a job, this will be the job, as defined in the original collection's job definition.
|
|
1479
1492
|
*/
|
|
1480
1493
|
job_job?: string;
|
|
1481
1494
|
/** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
|
|
1482
1495
|
*/
|
|
1483
1496
|
job_name?: string;
|
|
1497
|
+
/** The Job definition's unique ID
|
|
1498
|
+
*/
|
|
1499
|
+
job_id?: number;
|
|
1484
1500
|
/** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
|
|
1485
1501
|
*/
|
|
1486
1502
|
job_version?: string;
|
|
1487
|
-
/** The
|
|
1488
|
-
*/
|
|
1489
|
-
launched: string;
|
|
1490
|
-
/** The Instance name
|
|
1503
|
+
/** 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)
|
|
1491
1504
|
*/
|
|
1492
|
-
|
|
1505
|
+
job_image_type?: InstanceSummaryJobImageType;
|
|
1493
1506
|
/** The instance's known outputs, a JSON string defining a map of all the outputs. Typically applied only to JOB application types
|
|
1494
1507
|
*/
|
|
1495
1508
|
outputs?: string;
|
|
1496
|
-
/**
|
|
1497
|
-
*/
|
|
1498
|
-
owner: string;
|
|
1499
|
-
/** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
|
|
1500
|
-
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.
|
|
1501
|
-
*/
|
|
1502
|
-
phase: InstanceSummaryPhase;
|
|
1503
|
-
/** The Project the instances is running in.
|
|
1504
|
-
*/
|
|
1505
|
-
project_id: string;
|
|
1506
|
-
/** 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.
|
|
1507
|
-
*/
|
|
1508
|
-
run_time: string;
|
|
1509
|
-
/** The data and time (UTC) the instance started running
|
|
1509
|
+
/** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes.
|
|
1510
1510
|
*/
|
|
1511
|
-
|
|
1512
|
-
/** The
|
|
1511
|
+
fix_permissions?: boolean;
|
|
1512
|
+
/** The current running coin cost of the instance.
|
|
1513
1513
|
*/
|
|
1514
|
-
|
|
1515
|
-
/**
|
|
1514
|
+
coins?: string;
|
|
1515
|
+
/** If the instance has failed, this will be the error message
|
|
1516
1516
|
*/
|
|
1517
|
-
|
|
1517
|
+
error_message?: string;
|
|
1518
1518
|
}
|
|
1519
1519
|
|
|
1520
1520
|
export interface FileStat {
|
|
1521
|
-
/** The date and time (UTC) of the last modification
|
|
1522
|
-
*/
|
|
1523
|
-
modified: string;
|
|
1524
1521
|
/** The size of the file in bytes
|
|
1525
1522
|
*/
|
|
1526
1523
|
size: number;
|
|
1524
|
+
/** The date and time (UTC) of the last modification
|
|
1525
|
+
*/
|
|
1526
|
+
modified: string;
|
|
1527
1527
|
}
|
|
1528
1528
|
|
|
1529
1529
|
export interface FilePathFile {
|
|
1530
|
-
/** The code obtained from the Account Server
|
|
1531
|
-
*/
|
|
1532
|
-
authorisation_code?: number;
|
|
1533
1530
|
/** The file's Dataset ID (if the file belongs to a Dataset)
|
|
1534
1531
|
*/
|
|
1535
1532
|
dataset_id?: string;
|
|
1536
1533
|
/** The file's Dataset version (if the file belongs to a Dataset)
|
|
1537
1534
|
*/
|
|
1538
1535
|
dataset_version?: number;
|
|
1539
|
-
/** The ID of the file (if the file belongs to a Dataset)
|
|
1540
|
-
*/
|
|
1541
|
-
file_id?: string;
|
|
1542
1536
|
/** The file name
|
|
1543
1537
|
*/
|
|
1544
1538
|
file_name: string;
|
|
1539
|
+
/** The ID of the file (if the file belongs to a Dataset)
|
|
1540
|
+
*/
|
|
1541
|
+
file_id?: string;
|
|
1545
1542
|
/** Whether the file is immutable (read-only)
|
|
1546
1543
|
*/
|
|
1547
1544
|
immutable?: boolean;
|
|
@@ -1551,14 +1548,17 @@ export interface FilePathFile {
|
|
|
1551
1548
|
/** The file's owner
|
|
1552
1549
|
*/
|
|
1553
1550
|
owner: string;
|
|
1551
|
+
/** The code obtained from the Account Server
|
|
1552
|
+
*/
|
|
1553
|
+
authorisation_code?: number;
|
|
1554
1554
|
stat: FileStat;
|
|
1555
1555
|
}
|
|
1556
1556
|
|
|
1557
1557
|
export interface JobExchangeRateSummary {
|
|
1558
|
-
collection: string;
|
|
1559
1558
|
id: number;
|
|
1560
|
-
job: string;
|
|
1561
1559
|
rate?: string;
|
|
1560
|
+
collection: string;
|
|
1561
|
+
job: string;
|
|
1562
1562
|
version: string;
|
|
1563
1563
|
}
|
|
1564
1564
|
|
|
@@ -1568,13 +1568,19 @@ export interface ApplicationExchangeRateSummary {
|
|
|
1568
1568
|
}
|
|
1569
1569
|
|
|
1570
1570
|
export interface ExchangeRateDetail {
|
|
1571
|
-
comment?: string;
|
|
1572
|
-
created: string;
|
|
1573
1571
|
id: number;
|
|
1574
1572
|
rate: string;
|
|
1573
|
+
created: string;
|
|
1575
1574
|
user_id: string;
|
|
1575
|
+
comment?: string;
|
|
1576
1576
|
}
|
|
1577
1577
|
|
|
1578
|
+
/**
|
|
1579
|
+
* The dictionary of label/value pairs
|
|
1580
|
+
|
|
1581
|
+
*/
|
|
1582
|
+
export type DatasetVersionSummaryLabels = { [key: string]: unknown };
|
|
1583
|
+
|
|
1578
1584
|
/**
|
|
1579
1585
|
* 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
|
|
1580
1586
|
|
|
@@ -1592,66 +1598,66 @@ export const DatasetVersionSummaryProcessingStage = {
|
|
|
1592
1598
|
DONE: 'DONE',
|
|
1593
1599
|
} as const;
|
|
1594
1600
|
|
|
1595
|
-
/**
|
|
1596
|
-
* The dictionary of label/value pairs
|
|
1597
|
-
|
|
1598
|
-
*/
|
|
1599
|
-
export type DatasetVersionSummaryLabels = { [key: string]: unknown };
|
|
1600
|
-
|
|
1601
1601
|
export interface DatasetVersionSummary {
|
|
1602
|
-
/** The
|
|
1602
|
+
/** The owner of the Dataset version
|
|
1603
1603
|
*/
|
|
1604
|
-
|
|
1605
|
-
/** The
|
|
1604
|
+
owner?: string;
|
|
1605
|
+
/** The source of the Dataset - typically the name of the Dataset that was uploaded or a URL reference
|
|
1606
1606
|
*/
|
|
1607
|
-
|
|
1608
|
-
/**
|
|
1607
|
+
source_ref: string;
|
|
1608
|
+
/** The date and time the Dataset was uploaded (an ISO-8601 formatted string in UTC)
|
|
1609
1609
|
*/
|
|
1610
|
-
|
|
1611
|
-
/**
|
|
1610
|
+
published: string;
|
|
1611
|
+
/** The Dataset MIME type
|
|
1612
1612
|
*/
|
|
1613
|
-
|
|
1613
|
+
type: string;
|
|
1614
1614
|
/** The filename of the Dataset
|
|
1615
1615
|
*/
|
|
1616
1616
|
file_name: string;
|
|
1617
|
+
/** The list of Project's the Dataset is attached to
|
|
1618
|
+
*/
|
|
1619
|
+
projects: string[];
|
|
1617
1620
|
/** Any extra variables passed in during the upload and handed to the format-support container.
|
|
1618
1621
|
*/
|
|
1619
1622
|
format_extra_variables?: string;
|
|
1620
|
-
/** The
|
|
1623
|
+
/** The version of the dataset
|
|
1621
1624
|
*/
|
|
1622
|
-
|
|
1623
|
-
/** The
|
|
1625
|
+
version: number;
|
|
1626
|
+
/** The name of the Pod handling the creation of the Dataset
|
|
1624
1627
|
*/
|
|
1625
|
-
|
|
1628
|
+
creator_pod_name?: string;
|
|
1626
1629
|
/** 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
|
|
1627
1630
|
*/
|
|
1628
1631
|
processing_stage: DatasetVersionSummaryProcessingStage;
|
|
1629
|
-
/**
|
|
1632
|
+
/** If this is a Deleted dataset this is the date and time the dataset was deleted (an ISO-8601 formatted string in UTC)
|
|
1630
1633
|
*/
|
|
1631
|
-
|
|
1632
|
-
/**
|
|
1634
|
+
deleted?: string;
|
|
1635
|
+
/** If this is a Deleted dataset this is the username of the user that deleted the Dataset
|
|
1633
1636
|
*/
|
|
1634
|
-
|
|
1637
|
+
deleting_user?: string;
|
|
1638
|
+
/** The dictionary of label/value pairs
|
|
1639
|
+
*/
|
|
1640
|
+
labels?: DatasetVersionSummaryLabels;
|
|
1635
1641
|
/** The size, in bytes, of the formatted Dataset
|
|
1636
1642
|
*/
|
|
1637
1643
|
size?: number;
|
|
1638
|
-
/** The
|
|
1639
|
-
*/
|
|
1640
|
-
source_ref: string;
|
|
1641
|
-
/** The Dataset MIME type
|
|
1642
|
-
*/
|
|
1643
|
-
type: string;
|
|
1644
|
-
/** The version of the dataset
|
|
1644
|
+
/** The code obtained from the Account Server
|
|
1645
1645
|
*/
|
|
1646
|
-
|
|
1646
|
+
authorisation_code?: number;
|
|
1647
1647
|
}
|
|
1648
1648
|
|
|
1649
1649
|
export interface DatasetVersionProjectFile {
|
|
1650
|
-
files: string[];
|
|
1651
|
-
project: string;
|
|
1652
1650
|
project_name: string;
|
|
1651
|
+
project: string;
|
|
1652
|
+
files: string[];
|
|
1653
1653
|
}
|
|
1654
1654
|
|
|
1655
|
+
/**
|
|
1656
|
+
* The dictionary of label/value pairs
|
|
1657
|
+
|
|
1658
|
+
*/
|
|
1659
|
+
export type DatasetVersionDetailLabels = { [key: string]: unknown };
|
|
1660
|
+
|
|
1655
1661
|
/**
|
|
1656
1662
|
* 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
|
|
1657
1663
|
|
|
@@ -1669,61 +1675,55 @@ export const DatasetVersionDetailProcessingStage = {
|
|
|
1669
1675
|
DONE: 'DONE',
|
|
1670
1676
|
} as const;
|
|
1671
1677
|
|
|
1672
|
-
/**
|
|
1673
|
-
* The dictionary of label/value pairs
|
|
1674
|
-
|
|
1675
|
-
*/
|
|
1676
|
-
export type DatasetVersionDetailLabels = { [key: string]: unknown };
|
|
1677
|
-
|
|
1678
1678
|
export interface DatasetVersionDetail {
|
|
1679
|
-
/** The
|
|
1679
|
+
/** The owner of the Dataset version
|
|
1680
1680
|
*/
|
|
1681
|
-
|
|
1682
|
-
/** The
|
|
1681
|
+
owner: string;
|
|
1682
|
+
/** The source of the Dataset - typically the name of the Dataset that was uploaded or a URL reference
|
|
1683
1683
|
*/
|
|
1684
|
-
|
|
1685
|
-
/**
|
|
1684
|
+
source_ref: string;
|
|
1685
|
+
/** The date and time the Dataset was uploaded (an ISO-8601 formatted string in UTC)
|
|
1686
1686
|
*/
|
|
1687
|
-
|
|
1688
|
-
/**
|
|
1687
|
+
published: string;
|
|
1688
|
+
/** The Dataset MIME type
|
|
1689
1689
|
*/
|
|
1690
|
-
|
|
1690
|
+
type: string;
|
|
1691
1691
|
/** The filename of the Dataset
|
|
1692
1692
|
*/
|
|
1693
1693
|
file_name: string;
|
|
1694
|
+
/** The list of
|
|
1695
|
+
*/
|
|
1696
|
+
project_files: DatasetVersionProjectFile[];
|
|
1697
|
+
/** The list of Project's the Dataset is attached to
|
|
1698
|
+
*/
|
|
1699
|
+
projects: string[];
|
|
1694
1700
|
/** Any extra variables passed in during the upload and handed to the format-support container.
|
|
1695
1701
|
*/
|
|
1696
1702
|
format_extra_variables?: string;
|
|
1697
|
-
/** The
|
|
1703
|
+
/** The version of the dataset
|
|
1698
1704
|
*/
|
|
1699
|
-
|
|
1700
|
-
/** The
|
|
1705
|
+
version: number;
|
|
1706
|
+
/** The name of the Pod handling the creation of the Dataset
|
|
1701
1707
|
*/
|
|
1702
|
-
|
|
1708
|
+
creator_pod_name?: string;
|
|
1703
1709
|
/** 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
|
|
1704
1710
|
*/
|
|
1705
1711
|
processing_stage: DatasetVersionDetailProcessingStage;
|
|
1706
|
-
/**
|
|
1712
|
+
/** If this is a Deleted dataset this is the date and time the dataset was deleted (an ISO-8601 formatted string in UTC)
|
|
1707
1713
|
*/
|
|
1708
|
-
|
|
1709
|
-
/**
|
|
1714
|
+
deleted?: string;
|
|
1715
|
+
/** If this is a Deleted dataset this is the username of the user that deleted the Dataset
|
|
1710
1716
|
*/
|
|
1711
|
-
|
|
1712
|
-
/** The
|
|
1717
|
+
deleting_user?: string;
|
|
1718
|
+
/** The dictionary of label/value pairs
|
|
1713
1719
|
*/
|
|
1714
|
-
|
|
1720
|
+
labels?: DatasetVersionDetailLabels;
|
|
1715
1721
|
/** The size, in bytes, of the formatted Dataset
|
|
1716
1722
|
*/
|
|
1717
1723
|
size?: number;
|
|
1718
|
-
/** The
|
|
1719
|
-
*/
|
|
1720
|
-
source_ref: string;
|
|
1721
|
-
/** The Dataset MIME type
|
|
1722
|
-
*/
|
|
1723
|
-
type: string;
|
|
1724
|
-
/** The version of the dataset
|
|
1724
|
+
/** The code obtained from the Account Server
|
|
1725
1725
|
*/
|
|
1726
|
-
|
|
1726
|
+
authorisation_code?: number;
|
|
1727
1727
|
}
|
|
1728
1728
|
|
|
1729
1729
|
export interface DatasetSummary {
|
|
@@ -1757,23 +1757,23 @@ export interface DatasetDetail {
|
|
|
1757
1757
|
}
|
|
1758
1758
|
|
|
1759
1759
|
export interface ApplicationSummary {
|
|
1760
|
-
/** The application
|
|
1760
|
+
/** The application name, the value of the Kubernetes **Custom Resource Definition** `spec.names.kind` property
|
|
1761
1761
|
*/
|
|
1762
|
-
|
|
1762
|
+
kind: string;
|
|
1763
1763
|
/** The application group
|
|
1764
1764
|
*/
|
|
1765
1765
|
group?: string;
|
|
1766
|
-
/** The application
|
|
1766
|
+
/** The application unique reference, the value of the Kubernetes **Custom Resource Definition** `metadata.name` property
|
|
1767
1767
|
*/
|
|
1768
|
-
|
|
1768
|
+
application_id: string;
|
|
1769
1769
|
/** The application's latest version as declared in The **Custom Resource Definition**
|
|
1770
1770
|
*/
|
|
1771
1771
|
latest_version: string;
|
|
1772
1772
|
}
|
|
1773
1773
|
|
|
1774
1774
|
export interface ApplicationImageVariant {
|
|
1775
|
-
image: string;
|
|
1776
1775
|
name: string;
|
|
1776
|
+
image: string;
|
|
1777
1777
|
}
|
|
1778
1778
|
|
|
1779
1779
|
export interface ApplicationImageVariants {
|
|
@@ -1796,30 +1796,30 @@ export const ApiLogDetailMethod = {
|
|
|
1796
1796
|
} as const;
|
|
1797
1797
|
|
|
1798
1798
|
export interface ApiLogDetail {
|
|
1799
|
+
/** The REST method used. GET methods are not logged
|
|
1800
|
+
*/
|
|
1801
|
+
method: ApiLogDetailMethod;
|
|
1802
|
+
/** The API path used, e.g. `/dataset`
|
|
1803
|
+
*/
|
|
1804
|
+
path: string;
|
|
1799
1805
|
/** The date/time the API call began
|
|
1800
1806
|
*/
|
|
1801
1807
|
began: string;
|
|
1802
|
-
/** A JSON string representing the in-body properties used in the call
|
|
1803
|
-
*/
|
|
1804
|
-
body?: string;
|
|
1805
1808
|
/** The REST method approximate execution time (nS) in a humanised form, where 7969400 is presented as 7,969,400
|
|
1806
1809
|
*/
|
|
1807
1810
|
duration_ns?: string;
|
|
1808
|
-
/**
|
|
1809
|
-
*/
|
|
1810
|
-
impersonator?: string;
|
|
1811
|
-
/** The REST method used. GET methods are not logged
|
|
1811
|
+
/** The HTTP response status code
|
|
1812
1812
|
*/
|
|
1813
|
-
|
|
1813
|
+
status_code?: number;
|
|
1814
1814
|
/** A JSON string representing the in-query properties used in the call
|
|
1815
1815
|
*/
|
|
1816
1816
|
params?: string;
|
|
1817
|
-
/**
|
|
1817
|
+
/** A JSON string representing the in-body properties used in the call
|
|
1818
1818
|
*/
|
|
1819
|
-
|
|
1820
|
-
/**
|
|
1819
|
+
body?: string;
|
|
1820
|
+
/** 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
|
|
1821
1821
|
*/
|
|
1822
|
-
|
|
1822
|
+
impersonator?: string;
|
|
1823
1823
|
}
|
|
1824
1824
|
|
|
1825
1825
|
export interface ModeGetResponse {
|
|
@@ -1842,45 +1842,45 @@ export interface UsersGetResponse {
|
|
|
1842
1842
|
}
|
|
1843
1843
|
|
|
1844
1844
|
export interface UserApiLogGetResponse {
|
|
1845
|
+
count: number;
|
|
1845
1846
|
/** A list of API loc call records, with the oldest record first in the list
|
|
1846
1847
|
*/
|
|
1847
1848
|
api_log: ApiLogDetail[];
|
|
1848
|
-
count: number;
|
|
1849
1849
|
}
|
|
1850
1850
|
|
|
1851
1851
|
export interface UserActivityDetailPeriod {
|
|
1852
|
-
/**
|
|
1852
|
+
/** The period over which the activity is monitored
|
|
1853
1853
|
*/
|
|
1854
|
-
|
|
1854
|
+
monitoring_period: string;
|
|
1855
1855
|
/** The number of days the API has been used
|
|
1856
1856
|
*/
|
|
1857
1857
|
active_days: number;
|
|
1858
|
-
/** Active days, as a percentage, over the monitoring period.
|
|
1859
|
-
*/
|
|
1860
|
-
activity: string;
|
|
1861
1858
|
/** The number of days the API has not been used
|
|
1862
1859
|
*/
|
|
1863
1860
|
inactive_days: number;
|
|
1864
|
-
/**
|
|
1861
|
+
/** Active days, as a percentage, over the monitoring period.
|
|
1865
1862
|
*/
|
|
1866
|
-
|
|
1863
|
+
activity: string;
|
|
1864
|
+
/** A list of dates where the API has been used during the monitoring period. Dates are returned if when the activity is not 100% and active dates are present. Dates are listed in reverse chronological order (i.e. the most recent first)
|
|
1865
|
+
*/
|
|
1866
|
+
active_dates?: string[];
|
|
1867
1867
|
}
|
|
1868
1868
|
|
|
1869
1869
|
export interface UserActivityDetail {
|
|
1870
|
-
|
|
1871
|
-
period_b?: UserActivityDetailPeriod;
|
|
1872
|
-
/** The total percentage activity since first seen
|
|
1870
|
+
/** The total number of days since the user was first seen, including the day the user was first seen
|
|
1873
1871
|
*/
|
|
1874
|
-
|
|
1872
|
+
total_days_since_first_seen: number;
|
|
1875
1873
|
/** The total number of days active since first seen
|
|
1876
1874
|
*/
|
|
1877
1875
|
total_days_active: number;
|
|
1878
1876
|
/** The total number of days inactive since first seen
|
|
1879
1877
|
*/
|
|
1880
1878
|
total_days_inactive: number;
|
|
1881
|
-
/** The total
|
|
1879
|
+
/** The total percentage activity since first seen
|
|
1882
1880
|
*/
|
|
1883
|
-
|
|
1881
|
+
total_activity: string;
|
|
1882
|
+
period_a: UserActivityDetailPeriod;
|
|
1883
|
+
period_b?: UserActivityDetailPeriod;
|
|
1884
1884
|
}
|
|
1885
1885
|
|
|
1886
1886
|
export type UserAccountGetResponse = UserAccountDetail;
|
|
@@ -1915,24 +1915,6 @@ export const TaskGetResponsePurpose = {
|
|
|
1915
1915
|
} as const;
|
|
1916
1916
|
|
|
1917
1917
|
export interface TaskGetResponse {
|
|
1918
|
-
/** The date and time the task was created
|
|
1919
|
-
*/
|
|
1920
|
-
created: string;
|
|
1921
|
-
/** True if the task has run to completion. If the task finished successfully the `exit_code` will be zero.
|
|
1922
|
-
*/
|
|
1923
|
-
done: boolean;
|
|
1924
|
-
/** A (possibly empty) list of application events. The oldest event occupies the first position in the list.
|
|
1925
|
-
*/
|
|
1926
|
-
events?: TaskEvent[];
|
|
1927
|
-
/** Present when `done` and zero if the task finished successfully.
|
|
1928
|
-
*/
|
|
1929
|
-
exit_code?: number;
|
|
1930
|
-
/** If a container image is launched by the task the image name is available here
|
|
1931
|
-
*/
|
|
1932
|
-
image?: string;
|
|
1933
|
-
/** 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.
|
|
1934
|
-
*/
|
|
1935
|
-
instance_specification?: string;
|
|
1936
1918
|
/** 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`)
|
|
1937
1919
|
*/
|
|
1938
1920
|
purpose: TaskGetResponsePurpose;
|
|
@@ -1942,12 +1924,30 @@ export interface TaskGetResponse {
|
|
|
1942
1924
|
/** The version number, relating to the object under control. For Datasets this will be the Dataset version.
|
|
1943
1925
|
*/
|
|
1944
1926
|
purpose_version?: number;
|
|
1927
|
+
/** 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.
|
|
1928
|
+
*/
|
|
1929
|
+
instance_specification?: string;
|
|
1930
|
+
/** If a container image is launched by the task the image name is available here
|
|
1931
|
+
*/
|
|
1932
|
+
image?: string;
|
|
1933
|
+
/** The date and time the task was created
|
|
1934
|
+
*/
|
|
1935
|
+
created: string;
|
|
1936
|
+
/** True if the task has run to completion. If the task finished successfully the `exit_code` will be zero.
|
|
1937
|
+
*/
|
|
1938
|
+
done: boolean;
|
|
1945
1939
|
/** True if the Task relates to an object removal, i.e. a DELETE
|
|
1946
1940
|
*/
|
|
1947
1941
|
removal?: boolean;
|
|
1942
|
+
/** Present when `done` and zero if the task finished successfully.
|
|
1943
|
+
*/
|
|
1944
|
+
exit_code?: number;
|
|
1948
1945
|
/** A (possibly empty) list of application states, the oldest state occupies the first position in the list.
|
|
1949
1946
|
*/
|
|
1950
1947
|
states?: TaskState[];
|
|
1948
|
+
/** A (possibly empty) list of application events. The oldest event occupies the first position in the list.
|
|
1949
|
+
*/
|
|
1950
|
+
events?: TaskEvent[];
|
|
1951
1951
|
}
|
|
1952
1952
|
|
|
1953
1953
|
export interface ServiceErrorsGetResponse {
|
|
@@ -1993,76 +1993,76 @@ export const JobGetResponseImageType = {
|
|
|
1993
1993
|
} as const;
|
|
1994
1994
|
|
|
1995
1995
|
export interface JobGetResponse {
|
|
1996
|
-
|
|
1997
|
-
/** The Job's category
|
|
1996
|
+
/** The Job's unique ID
|
|
1998
1997
|
*/
|
|
1999
|
-
|
|
1998
|
+
id: number;
|
|
1999
|
+
application: ApplicationSummary;
|
|
2000
2000
|
/** The Job collection
|
|
2001
2001
|
*/
|
|
2002
2002
|
collection: string;
|
|
2003
|
+
/** The Job name, unique within a given collection
|
|
2004
|
+
*/
|
|
2005
|
+
job: string;
|
|
2006
|
+
/** The Job version
|
|
2007
|
+
*/
|
|
2008
|
+
version: string;
|
|
2003
2009
|
/** The Job command (usually encoded)
|
|
2004
2010
|
*/
|
|
2005
2011
|
command: string;
|
|
2006
2012
|
/** The Job command encoding
|
|
2007
2013
|
*/
|
|
2008
2014
|
command_encoding: string;
|
|
2009
|
-
/** English description of the job
|
|
2010
|
-
*/
|
|
2011
|
-
description?: string;
|
|
2012
|
-
/** True if disabled. Disabled Jobs cannot be executed. If disabled a reason will be found in `disabled_reason`
|
|
2013
|
-
*/
|
|
2014
|
-
disabled: boolean;
|
|
2015
|
-
/** A reason why the Job has been disabled.
|
|
2016
|
-
*/
|
|
2017
|
-
disabled_reason?: string;
|
|
2018
|
-
/** 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).
|
|
2019
|
-
|
|
2020
|
-
Where there is no remedy for a given reason the remedy will be "There is no remedy".
|
|
2021
|
-
*/
|
|
2022
|
-
disabled_remedy?: string;
|
|
2023
|
-
/** A URL linking to the Job documentation
|
|
2024
|
-
*/
|
|
2025
|
-
doc_url?: string;
|
|
2026
|
-
exchange_rate: string;
|
|
2027
|
-
/** The Job's unique ID
|
|
2028
|
-
*/
|
|
2029
|
-
id: number;
|
|
2030
2015
|
/** The name of the container image that houses the job
|
|
2031
2016
|
*/
|
|
2032
2017
|
image_name: string;
|
|
2018
|
+
/** The container image tag
|
|
2019
|
+
*/
|
|
2020
|
+
image_tag: string;
|
|
2033
2021
|
/** The directory where the project volume will be mounted. The root path to the project files
|
|
2034
2022
|
*/
|
|
2035
2023
|
image_project_directory: string;
|
|
2036
|
-
/** The container image
|
|
2024
|
+
/** The directory used as the container image working directory (if defined)
|
|
2037
2025
|
*/
|
|
2038
|
-
|
|
2026
|
+
image_working_directory?: unknown;
|
|
2039
2027
|
/** 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`)
|
|
2040
2028
|
*/
|
|
2041
2029
|
image_type?: JobGetResponseImageType;
|
|
2042
|
-
/** The
|
|
2030
|
+
/** The Job's descriptive name
|
|
2043
2031
|
*/
|
|
2044
|
-
|
|
2045
|
-
/**
|
|
2032
|
+
name: string;
|
|
2033
|
+
/** English description of the job
|
|
2046
2034
|
*/
|
|
2047
|
-
|
|
2035
|
+
description?: string;
|
|
2036
|
+
/** A URL linking to the Job documentation
|
|
2037
|
+
*/
|
|
2038
|
+
doc_url?: string;
|
|
2039
|
+
/** The Job's category
|
|
2040
|
+
*/
|
|
2041
|
+
category?: string;
|
|
2048
2042
|
/** The list of keywords assigned to the Job
|
|
2049
2043
|
*/
|
|
2050
2044
|
keywords?: string[];
|
|
2045
|
+
variables?: JobVariables;
|
|
2046
|
+
exchange_rate: string;
|
|
2047
|
+
/** A list of Account Server assets names required to run the Job. You need access to these assets in order to run the Job
|
|
2048
|
+
*/
|
|
2049
|
+
required_assets: string[];
|
|
2051
2050
|
/** 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.
|
|
2052
2051
|
*/
|
|
2053
2052
|
missing_assets?: string[];
|
|
2054
|
-
/**
|
|
2053
|
+
/** True if disabled. Disabled Jobs cannot be executed. If disabled a reason will be found in `disabled_reason`
|
|
2055
2054
|
*/
|
|
2056
|
-
|
|
2057
|
-
|
|
2058
|
-
replaces?: JobReplacements;
|
|
2059
|
-
/** A list of Account Server assets names required to run the Job. You need access to these assets in order to run the Job
|
|
2055
|
+
disabled: boolean;
|
|
2056
|
+
/** A reason why the Job has been disabled.
|
|
2060
2057
|
*/
|
|
2061
|
-
|
|
2062
|
-
|
|
2063
|
-
|
|
2058
|
+
disabled_reason?: string;
|
|
2059
|
+
/** 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).
|
|
2060
|
+
|
|
2061
|
+
Where there is no remedy for a given reason the remedy will be "There is no remedy".
|
|
2064
2062
|
*/
|
|
2065
|
-
|
|
2063
|
+
disabled_remedy?: string;
|
|
2064
|
+
replaces?: JobReplacements;
|
|
2065
|
+
replaced_by?: JobReplacements;
|
|
2066
2066
|
}
|
|
2067
2067
|
|
|
2068
2068
|
export interface InventoryProjectDetail {
|
|
@@ -2072,31 +2072,31 @@ export interface InventoryProjectDetail {
|
|
|
2072
2072
|
}
|
|
2073
2073
|
|
|
2074
2074
|
export interface InventoryDatasetDetail {
|
|
2075
|
+
id: string;
|
|
2076
|
+
version: number;
|
|
2075
2077
|
filename: string;
|
|
2076
|
-
id: string;
|
|
2077
2078
|
unit_id: string;
|
|
2078
|
-
version: number;
|
|
2079
2079
|
}
|
|
2080
2080
|
|
|
2081
|
+
export type InventoryUserDetailDatasets = {
|
|
2082
|
+
owner?: InventoryDatasetDetail[];
|
|
2083
|
+
editor?: InventoryDatasetDetail[];
|
|
2084
|
+
};
|
|
2085
|
+
|
|
2081
2086
|
export type InventoryUserDetailProjects = {
|
|
2082
2087
|
administrator: InventoryProjectDetail[];
|
|
2083
2088
|
editor: InventoryProjectDetail[];
|
|
2084
2089
|
observer: InventoryProjectDetail[];
|
|
2085
2090
|
};
|
|
2086
2091
|
|
|
2087
|
-
export type InventoryUserDetailDatasets = {
|
|
2088
|
-
editor?: InventoryDatasetDetail[];
|
|
2089
|
-
owner?: InventoryDatasetDetail[];
|
|
2090
|
-
};
|
|
2091
|
-
|
|
2092
2092
|
export interface InventoryUserDetail {
|
|
2093
|
-
activity: UserActivityDetail;
|
|
2094
|
-
datasets: InventoryUserDetailDatasets;
|
|
2095
2093
|
f_uid: number;
|
|
2096
2094
|
first_seen: string;
|
|
2097
2095
|
last_seen_date: string;
|
|
2098
|
-
projects: InventoryUserDetailProjects;
|
|
2099
2096
|
username: string;
|
|
2097
|
+
projects: InventoryUserDetailProjects;
|
|
2098
|
+
datasets: InventoryUserDetailDatasets;
|
|
2099
|
+
activity: UserActivityDetail;
|
|
2100
2100
|
}
|
|
2101
2101
|
|
|
2102
2102
|
export type InstanceTaskPurpose = typeof InstanceTaskPurpose[keyof typeof InstanceTaskPurpose];
|
|
@@ -2118,6 +2118,19 @@ export interface InstancesGetResponse {
|
|
|
2118
2118
|
instances: InstanceSummary[];
|
|
2119
2119
|
}
|
|
2120
2120
|
|
|
2121
|
+
/**
|
|
2122
|
+
* 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)
|
|
2123
|
+
|
|
2124
|
+
*/
|
|
2125
|
+
export type InstanceGetResponseJobImageType = typeof InstanceGetResponseJobImageType[keyof typeof InstanceGetResponseJobImageType];
|
|
2126
|
+
|
|
2127
|
+
|
|
2128
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
2129
|
+
export const InstanceGetResponseJobImageType = {
|
|
2130
|
+
SIMPLE: 'SIMPLE',
|
|
2131
|
+
NEXTFLOW: 'NEXTFLOW',
|
|
2132
|
+
} as const;
|
|
2133
|
+
|
|
2121
2134
|
/**
|
|
2122
2135
|
* The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
|
|
2123
2136
|
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.
|
|
@@ -2138,19 +2151,6 @@ export const InstanceGetResponsePhase = {
|
|
|
2138
2151
|
UNKNOWN: 'UNKNOWN',
|
|
2139
2152
|
} as const;
|
|
2140
2153
|
|
|
2141
|
-
/**
|
|
2142
|
-
* 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)
|
|
2143
|
-
|
|
2144
|
-
*/
|
|
2145
|
-
export type InstanceGetResponseJobImageType = typeof InstanceGetResponseJobImageType[keyof typeof InstanceGetResponseJobImageType];
|
|
2146
|
-
|
|
2147
|
-
|
|
2148
|
-
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
2149
|
-
export const InstanceGetResponseJobImageType = {
|
|
2150
|
-
SIMPLE: 'SIMPLE',
|
|
2151
|
-
NEXTFLOW: 'NEXTFLOW',
|
|
2152
|
-
} as const;
|
|
2153
|
-
|
|
2154
2154
|
/**
|
|
2155
2155
|
* The type of Application, which can be a `job` or an `application`
|
|
2156
2156
|
|
|
@@ -2165,100 +2165,100 @@ export const InstanceGetResponseApplicationType = {
|
|
|
2165
2165
|
} as const;
|
|
2166
2166
|
|
|
2167
2167
|
export interface InstanceGetResponse {
|
|
2168
|
-
/** The
|
|
2168
|
+
/** The Project the Instance is running in
|
|
2169
2169
|
*/
|
|
2170
|
-
|
|
2171
|
-
/** The
|
|
2170
|
+
project_id: string;
|
|
2171
|
+
/** The application name
|
|
2172
2172
|
*/
|
|
2173
|
-
|
|
2173
|
+
name: string;
|
|
2174
|
+
/** True if the instance is archived (protected from automatic deletion)
|
|
2175
|
+
*/
|
|
2176
|
+
archived: boolean;
|
|
2174
2177
|
/** The type of Application, which can be a `job` or an `application`
|
|
2175
2178
|
*/
|
|
2176
2179
|
application_type: InstanceGetResponseApplicationType;
|
|
2180
|
+
/** The application ID
|
|
2181
|
+
*/
|
|
2182
|
+
application_id: string;
|
|
2177
2183
|
/** The application version
|
|
2178
2184
|
*/
|
|
2179
2185
|
application_version: string;
|
|
2180
|
-
/**
|
|
2186
|
+
/** The optional application specification. For **Applications** this is returned verbatim. For **Jobs** additional material will be found.
|
|
2181
2187
|
*/
|
|
2182
|
-
|
|
2188
|
+
application_specification?: string;
|
|
2183
2189
|
/** The code obtained from the Account Server
|
|
2184
2190
|
*/
|
|
2185
2191
|
authorisation_code?: number;
|
|
2186
|
-
/** The
|
|
2192
|
+
/** The application owner, the person who launched the application and is the only user than can stop it.
|
|
2187
2193
|
*/
|
|
2188
|
-
|
|
2189
|
-
/**
|
|
2194
|
+
owner: string;
|
|
2195
|
+
/** The date and time the instance was started, an ISO-8601 format string.
|
|
2190
2196
|
*/
|
|
2191
|
-
|
|
2192
|
-
/**
|
|
2197
|
+
launched: string;
|
|
2198
|
+
/** 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.
|
|
2193
2199
|
*/
|
|
2194
|
-
|
|
2195
|
-
/** The
|
|
2200
|
+
started?: string;
|
|
2201
|
+
/** The date and time the instance stopped, an ISO-8601 format string.
|
|
2196
2202
|
*/
|
|
2197
|
-
|
|
2198
|
-
/**
|
|
2203
|
+
stopped?: string;
|
|
2204
|
+
/** 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.
|
|
2199
2205
|
*/
|
|
2200
|
-
|
|
2201
|
-
/**
|
|
2206
|
+
run_time: string;
|
|
2207
|
+
/** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
|
|
2208
|
+
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.
|
|
2202
2209
|
*/
|
|
2203
|
-
|
|
2204
|
-
/**
|
|
2210
|
+
phase: InstanceGetResponsePhase;
|
|
2211
|
+
/** The application endpoint
|
|
2205
2212
|
*/
|
|
2206
|
-
|
|
2213
|
+
url?: string;
|
|
2207
2214
|
/** If the instance relates to a job, this will be the job collection, as defined in the original collection's job definition.
|
|
2208
2215
|
*/
|
|
2209
2216
|
job_collection?: string;
|
|
2210
|
-
/** The Job definition's unique ID
|
|
2211
|
-
*/
|
|
2212
|
-
job_id?: number;
|
|
2213
|
-
/** 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)
|
|
2214
|
-
*/
|
|
2215
|
-
job_image_type?: InstanceGetResponseJobImageType;
|
|
2216
2217
|
/** If the instance relates to a job, this will be the job, as defined in the original collection's job definition.
|
|
2217
2218
|
*/
|
|
2218
2219
|
job_job?: string;
|
|
2219
2220
|
/** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
|
|
2220
2221
|
*/
|
|
2221
2222
|
job_name?: string;
|
|
2223
|
+
/** The Job definition's unique ID
|
|
2224
|
+
*/
|
|
2225
|
+
job_id?: number;
|
|
2222
2226
|
/** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
|
|
2223
2227
|
*/
|
|
2224
2228
|
job_version?: string;
|
|
2225
|
-
/** The
|
|
2226
|
-
*/
|
|
2227
|
-
launch_exchange_rate?: string;
|
|
2228
|
-
/** The date and time the instance was started, an ISO-8601 format string.
|
|
2229
|
-
*/
|
|
2230
|
-
launched: string;
|
|
2231
|
-
/** The application name
|
|
2229
|
+
/** 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)
|
|
2232
2230
|
*/
|
|
2233
|
-
|
|
2231
|
+
job_image_type?: InstanceGetResponseJobImageType;
|
|
2234
2232
|
/** The JSON string representation of the JobDefinition's outputs
|
|
2235
2233
|
*/
|
|
2236
2234
|
outputs?: string;
|
|
2237
|
-
/**
|
|
2235
|
+
/** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes.
|
|
2238
2236
|
*/
|
|
2239
|
-
|
|
2240
|
-
/**
|
|
2241
|
-
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.
|
|
2237
|
+
fix_permissions?: boolean;
|
|
2238
|
+
/** 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.
|
|
2242
2239
|
*/
|
|
2243
|
-
|
|
2244
|
-
/**
|
|
2240
|
+
tasks: InstanceTask[];
|
|
2241
|
+
/** Set if the instance has a valid callback token. Instances with a valid token allow users to read files form the project without authentication
|
|
2245
2242
|
*/
|
|
2246
|
-
|
|
2247
|
-
/** The
|
|
2243
|
+
has_valid_callback_token: boolean;
|
|
2244
|
+
/** 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'`
|
|
2248
2245
|
*/
|
|
2249
|
-
|
|
2250
|
-
/** The
|
|
2246
|
+
launch_exchange_rate?: string;
|
|
2247
|
+
/** 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'`
|
|
2251
2248
|
*/
|
|
2252
|
-
|
|
2253
|
-
/** The
|
|
2249
|
+
cost?: string;
|
|
2250
|
+
/** 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'`
|
|
2254
2251
|
*/
|
|
2255
|
-
|
|
2256
|
-
/**
|
|
2252
|
+
coins?: string;
|
|
2253
|
+
/** 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).
|
|
2257
2254
|
*/
|
|
2258
|
-
|
|
2259
|
-
/**
|
|
2255
|
+
collateral_cpu_hours?: string;
|
|
2256
|
+
/** 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.
|
|
2260
2257
|
*/
|
|
2261
|
-
|
|
2258
|
+
collateral_pod_count?: number;
|
|
2259
|
+
/** An optional error message, used to report underlying problems.
|
|
2260
|
+
*/
|
|
2261
|
+
error_message?: string;
|
|
2262
2262
|
/** A list of Project-relative annotation files.
|
|
2263
2263
|
*/
|
|
2264
2264
|
written_job_annotation_files?: string[];
|
|
@@ -2267,35 +2267,35 @@ The initial phase, indicating that the Instance is preparing to run, is `PENDING
|
|
|
2267
2267
|
export type GetExchangeRatesResponseId = number | string;
|
|
2268
2268
|
|
|
2269
2269
|
export interface GetExchangeRatesResponse {
|
|
2270
|
+
id: GetExchangeRatesResponseId;
|
|
2270
2271
|
count: number;
|
|
2271
2272
|
exchange_rates: ExchangeRateDetail[];
|
|
2272
|
-
id: GetExchangeRatesResponseId;
|
|
2273
2273
|
}
|
|
2274
2274
|
|
|
2275
2275
|
export type GetAllExchangeRatesResponseExchangeRatesItem = ApplicationExchangeRateSummary | JobExchangeRateSummary;
|
|
2276
2276
|
|
|
2277
2277
|
export interface GetAllExchangeRatesResponse {
|
|
2278
2278
|
count: number;
|
|
2279
|
-
exchange_rates: GetAllExchangeRatesResponseExchangeRatesItem[];
|
|
2280
2279
|
only_undefined: boolean;
|
|
2280
|
+
exchange_rates: GetAllExchangeRatesResponseExchangeRatesItem[];
|
|
2281
2281
|
}
|
|
2282
2282
|
|
|
2283
2283
|
export interface FilesGetResponse {
|
|
2284
2284
|
/** The number of files in the Project path
|
|
2285
2285
|
*/
|
|
2286
2286
|
count: number;
|
|
2287
|
-
/** The
|
|
2287
|
+
/** The project
|
|
2288
2288
|
*/
|
|
2289
|
-
|
|
2289
|
+
project_id: string;
|
|
2290
2290
|
/** The project path
|
|
2291
2291
|
*/
|
|
2292
2292
|
path: string;
|
|
2293
|
+
/** The dataset identity (not its name). A unique reference assigned automatically when uploaded
|
|
2294
|
+
*/
|
|
2295
|
+
files: FilePathFile[];
|
|
2293
2296
|
/** Sub-directories in the current path
|
|
2294
2297
|
*/
|
|
2295
2298
|
paths: string[];
|
|
2296
|
-
/** The project
|
|
2297
|
-
*/
|
|
2298
|
-
project_id: string;
|
|
2299
2299
|
}
|
|
2300
2300
|
|
|
2301
2301
|
export interface FilePostResponse {
|
|
@@ -2314,18 +2314,18 @@ export interface FilePostResponse {
|
|
|
2314
2314
|
}
|
|
2315
2315
|
|
|
2316
2316
|
export interface InstancePostResponse {
|
|
2317
|
-
/** 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.
|
|
2318
|
-
*/
|
|
2319
|
-
callback_token?: string;
|
|
2320
|
-
/** The instance expanded command. Applies only to Job instances.
|
|
2321
|
-
*/
|
|
2322
|
-
command?: string;
|
|
2323
2317
|
/** The application instance identity (not its name). Assigned automatically when created
|
|
2324
2318
|
*/
|
|
2325
2319
|
instance_id: string;
|
|
2320
|
+
/** 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.
|
|
2321
|
+
*/
|
|
2322
|
+
callback_token?: string;
|
|
2326
2323
|
/** The instance task identity. The task assigned to process the instance
|
|
2327
2324
|
*/
|
|
2328
2325
|
task_id: string;
|
|
2326
|
+
/** The instance expanded command. Applies only to Job instances.
|
|
2327
|
+
*/
|
|
2328
|
+
command?: string;
|
|
2329
2329
|
}
|
|
2330
2330
|
|
|
2331
2331
|
export interface InstanceDryRunPostResponse {
|
|
@@ -2361,49 +2361,49 @@ export const DatasetSchemaGetResponseType = {
|
|
|
2361
2361
|
} as const;
|
|
2362
2362
|
|
|
2363
2363
|
export interface DatasetSchemaGetResponse {
|
|
2364
|
-
/** The Metadata description
|
|
2365
|
-
*/
|
|
2366
|
-
description: string;
|
|
2367
|
-
/** Required properties
|
|
2368
|
-
*/
|
|
2369
|
-
required: string[];
|
|
2370
2364
|
/** The Metadata title
|
|
2371
2365
|
*/
|
|
2372
2366
|
title: string;
|
|
2367
|
+
/** The Metadata description
|
|
2368
|
+
*/
|
|
2369
|
+
description: string;
|
|
2373
2370
|
/** The Metadata type (an object)
|
|
2374
2371
|
*/
|
|
2375
2372
|
type: DatasetSchemaGetResponseType;
|
|
2373
|
+
/** Required properties
|
|
2374
|
+
*/
|
|
2375
|
+
required: string[];
|
|
2376
2376
|
[key: string]: unknown;
|
|
2377
2377
|
}
|
|
2378
2378
|
|
|
2379
2379
|
export interface DatasetMetaGetResponse {
|
|
2380
|
-
/** The Metadata
|
|
2381
|
-
*/
|
|
2382
|
-
annotations: unknown[];
|
|
2383
|
-
/** The date and time of creation
|
|
2384
|
-
*/
|
|
2385
|
-
created: string;
|
|
2386
|
-
/** The user who created the Metadata
|
|
2380
|
+
/** The Metadata title
|
|
2387
2381
|
*/
|
|
2388
|
-
|
|
2382
|
+
dataset_name: string;
|
|
2389
2383
|
/** The Metadata description
|
|
2390
2384
|
*/
|
|
2391
2385
|
dataset_id: string;
|
|
2392
|
-
/** The Metadata title
|
|
2393
|
-
*/
|
|
2394
|
-
dataset_name: string;
|
|
2395
2386
|
/** The Metadata type (an object)
|
|
2396
2387
|
*/
|
|
2397
2388
|
description: string;
|
|
2398
|
-
/** The
|
|
2389
|
+
/** The date and time of creation
|
|
2399
2390
|
*/
|
|
2400
|
-
|
|
2391
|
+
created: string;
|
|
2401
2392
|
/** The date and time it was last updated
|
|
2402
2393
|
*/
|
|
2403
2394
|
last_updated: string;
|
|
2395
|
+
/** The user who created the Metadata
|
|
2396
|
+
*/
|
|
2397
|
+
created_by: string;
|
|
2404
2398
|
/** The Metadata version
|
|
2405
2399
|
*/
|
|
2406
2400
|
metadata_version: string;
|
|
2401
|
+
/** The Metadata's annotations
|
|
2402
|
+
*/
|
|
2403
|
+
annotations: unknown[];
|
|
2404
|
+
/** The Metadata's labels
|
|
2405
|
+
*/
|
|
2406
|
+
labels: unknown[];
|
|
2407
2407
|
[key: string]: unknown;
|
|
2408
2408
|
}
|
|
2409
2409
|
|
|
@@ -2432,37 +2432,37 @@ export interface DatasetPutPostResponse {
|
|
|
2432
2432
|
}
|
|
2433
2433
|
|
|
2434
2434
|
export interface ApplicationsGetResponse {
|
|
2435
|
-
/** A list of installed applications, which are application-compliant Kubernetes "operators"
|
|
2436
|
-
*/
|
|
2437
|
-
applications: ApplicationSummary[];
|
|
2438
2435
|
/** The number of known Applications
|
|
2439
2436
|
*/
|
|
2440
2437
|
count: number;
|
|
2438
|
+
/** A list of installed applications, which are application-compliant Kubernetes "operators"
|
|
2439
|
+
*/
|
|
2440
|
+
applications: ApplicationSummary[];
|
|
2441
2441
|
}
|
|
2442
2442
|
|
|
2443
2443
|
export interface ApplicationGetResponse {
|
|
2444
|
+
/** The Application's unique ID
|
|
2445
|
+
*/
|
|
2446
|
+
id: string;
|
|
2444
2447
|
/** The Application COST exchange rate
|
|
2445
2448
|
*/
|
|
2446
2449
|
exchange_rate: string;
|
|
2447
|
-
/** The application
|
|
2448
|
-
*/
|
|
2449
|
-
group: string;
|
|
2450
|
-
/** The Application's unique ID
|
|
2450
|
+
/** The application specification template. Used when creating application instances
|
|
2451
2451
|
*/
|
|
2452
|
-
|
|
2453
|
-
image_variants?: ApplicationImageVariants;
|
|
2452
|
+
template: string;
|
|
2454
2453
|
/** A list of instances of the application
|
|
2455
2454
|
*/
|
|
2456
2455
|
instances: string[];
|
|
2456
|
+
/** The application group
|
|
2457
|
+
*/
|
|
2458
|
+
group: string;
|
|
2457
2459
|
/** The name (kind) of the application
|
|
2458
2460
|
*/
|
|
2459
2461
|
kind: string;
|
|
2460
|
-
/** The application specification template. Used when creating application instances
|
|
2461
|
-
*/
|
|
2462
|
-
template: string;
|
|
2463
2462
|
/** The list of available versions
|
|
2464
2463
|
*/
|
|
2465
2464
|
versions: string[];
|
|
2465
|
+
image_variants?: ApplicationImageVariants;
|
|
2466
2466
|
}
|
|
2467
2467
|
|
|
2468
2468
|
export interface AdminUsersGetResponse {
|
|
@@ -2477,15 +2477,12 @@ export interface AdminUsersGetResponse {
|
|
|
2477
2477
|
export type AdminUserPutResponse = UserAccountDetail;
|
|
2478
2478
|
|
|
2479
2479
|
export interface AdminJobManifestLoadPutResponse {
|
|
2480
|
-
/**
|
|
2481
|
-
*/
|
|
2482
|
-
job_definition_failures?: string[];
|
|
2483
|
-
/** Errors raised during Job Definition file processing
|
|
2480
|
+
/** True if there are no errors, false otherwise
|
|
2484
2481
|
*/
|
|
2485
|
-
|
|
2486
|
-
/**
|
|
2482
|
+
status: boolean;
|
|
2483
|
+
/** The number of Job Manifests inspected
|
|
2487
2484
|
*/
|
|
2488
|
-
|
|
2485
|
+
num_manifest_files_inspected: number;
|
|
2489
2486
|
/** The number of Job Definitions inspected
|
|
2490
2487
|
*/
|
|
2491
2488
|
num_job_definition_files_inspected: number;
|
|
@@ -2498,12 +2495,15 @@ export interface AdminJobManifestLoadPutResponse {
|
|
|
2498
2495
|
/** The number of Jobs removed
|
|
2499
2496
|
*/
|
|
2500
2497
|
num_jobs_purged?: number;
|
|
2501
|
-
/**
|
|
2498
|
+
/** Errors raised during Manifests file processing
|
|
2502
2499
|
*/
|
|
2503
|
-
|
|
2504
|
-
/**
|
|
2500
|
+
manifest_file_failures?: string[];
|
|
2501
|
+
/** Errors raised during Job Definition file processing
|
|
2505
2502
|
*/
|
|
2506
|
-
|
|
2503
|
+
job_definition_file_failures?: string[];
|
|
2504
|
+
/** Errors raised during the processing of individual Job Definitions
|
|
2505
|
+
*/
|
|
2506
|
+
job_definition_failures?: string[];
|
|
2507
2507
|
}
|
|
2508
2508
|
|
|
2509
2509
|
export interface InventoryUserGetResponse {
|