flywheel-sdk 19.3.0rc1__py2.py3-none-any.whl → 19.4.0__py2.py3-none-any.whl
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.
- flywheel/__init__.py +1 -0
- flywheel/api/acquisitions_api.py +134 -28
- flywheel/api/analyses_api.py +125 -21
- flywheel/api/collections_api.py +122 -12
- flywheel/api/containers_api.py +25 -27
- flywheel/api/files_api.py +212 -4
- flywheel/api/groups_api.py +109 -1
- flywheel/api/jobs_api.py +5 -1
- flywheel/api/projects_api.py +149 -31
- flywheel/api/sessions_api.py +144 -30
- flywheel/api/subjects_api.py +139 -29
- flywheel/api/tree_api.py +5 -1
- flywheel/api/users_api.py +15 -3
- flywheel/api_client.py +1 -1
- flywheel/configuration.py +2 -2
- flywheel/flywheel.py +207 -187
- flywheel/models/__init__.py +2 -1
- flywheel/models/daily_report_usage.py +62 -4
- flywheel/models/features.py +16 -16
- flywheel/models/filter.py +217 -0
- flywheel/models/mixins.py +33 -2
- flywheel/models/report_usage.py +88 -1
- {flywheel_sdk-19.3.0rc1.dist-info → flywheel_sdk-19.4.0.dist-info}/METADATA +6 -6
- {flywheel_sdk-19.3.0rc1.dist-info → flywheel_sdk-19.4.0.dist-info}/RECORD +27 -26
- {flywheel_sdk-19.3.0rc1.dist-info → flywheel_sdk-19.4.0.dist-info}/WHEEL +1 -1
- {flywheel_sdk-19.3.0rc1.dist-info → flywheel_sdk-19.4.0.dist-info}/LICENSE.txt +0 -0
- {flywheel_sdk-19.3.0rc1.dist-info → flywheel_sdk-19.4.0.dist-info}/top_level.txt +0 -0
flywheel/flywheel.py
CHANGED
|
@@ -40,7 +40,7 @@ from flywheel.view_builder import ViewBuilder
|
|
|
40
40
|
from flywheel.finder import Finder
|
|
41
41
|
import flywheel.api
|
|
42
42
|
|
|
43
|
-
SDK_VERSION = "19.
|
|
43
|
+
SDK_VERSION = "19.4.0"
|
|
44
44
|
|
|
45
45
|
def config_from_api_key(api_key):
|
|
46
46
|
parts = api_key.split(':')
|
|
@@ -381,6 +381,19 @@ class Flywheel:
|
|
|
381
381
|
return self.acquisitions_api.delete_acquisitions_by_ids(body, **kwargs)
|
|
382
382
|
|
|
383
383
|
|
|
384
|
+
def delete_acquisitions_by_query(self, body, **kwargs): # noqa: E501
|
|
385
|
+
"""Delete multiple acquisitions by query
|
|
386
|
+
|
|
387
|
+
Delete multiple acquisitions by query
|
|
388
|
+
|
|
389
|
+
:param list[Filter] body: Query for containers to delete (required)
|
|
390
|
+
:param ContainerDeleteReason delete_reason:
|
|
391
|
+
:param bool async_: Perform the request asynchronously
|
|
392
|
+
:return: DeletedResult
|
|
393
|
+
"""
|
|
394
|
+
return self.acquisitions_api.delete_acquisitions_by_query(body, **kwargs)
|
|
395
|
+
|
|
396
|
+
|
|
384
397
|
def download_file_from_acquisition(self, acquisition_id, file_name, dest_file, **kwargs): # noqa: E501
|
|
385
398
|
"""Download a file.
|
|
386
399
|
|
|
@@ -403,9 +416,9 @@ class Flywheel:
|
|
|
403
416
|
|
|
404
417
|
|
|
405
418
|
def get_acquisition_file_zip_info(self, acquisition_id, file_name, **kwargs): # noqa: E501
|
|
406
|
-
"""
|
|
419
|
+
"""Retrieve the zip info of a child file by name.
|
|
407
420
|
|
|
408
|
-
|
|
421
|
+
Does not work on files whose names contain a forward slash.
|
|
409
422
|
|
|
410
423
|
:param str acquisition_id: 24-character hex ID (required)
|
|
411
424
|
:param str file_name: output file name (required)
|
|
@@ -424,9 +437,7 @@ class Flywheel:
|
|
|
424
437
|
|
|
425
438
|
|
|
426
439
|
def get_acquisition_download_url(self, acquisition_id, file_name, **kwargs): # noqa: E501
|
|
427
|
-
"""
|
|
428
|
-
|
|
429
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
440
|
+
"""Get a signed URL to download a named child file.
|
|
430
441
|
|
|
431
442
|
:param str acquisition_id: 24-character hex ID (required)
|
|
432
443
|
:param str file_name: output file name (required)
|
|
@@ -470,9 +481,9 @@ class Flywheel:
|
|
|
470
481
|
|
|
471
482
|
|
|
472
483
|
def get_acquisition_analysis_input_zip_info(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
473
|
-
"""
|
|
484
|
+
"""Retrieve the zip info of a child file by name.
|
|
474
485
|
|
|
475
|
-
|
|
486
|
+
Does not work on files whose names contain a forward slash.
|
|
476
487
|
|
|
477
488
|
:param str acquisition_id: 24-character hex ID (required)
|
|
478
489
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -490,9 +501,7 @@ class Flywheel:
|
|
|
490
501
|
|
|
491
502
|
|
|
492
503
|
def get_acquisition_analysis_input_download_url(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
493
|
-
"""
|
|
494
|
-
|
|
495
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
504
|
+
"""Get a signed URL to download a named child file.
|
|
496
505
|
|
|
497
506
|
:param str acquisition_id: 24-character hex ID (required)
|
|
498
507
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -535,9 +544,9 @@ class Flywheel:
|
|
|
535
544
|
|
|
536
545
|
|
|
537
546
|
def get_acquisition_analysis_output_zip_info(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
538
|
-
"""
|
|
547
|
+
"""Retrieve the zip info of a child file by name.
|
|
539
548
|
|
|
540
|
-
|
|
549
|
+
Does not work on files whose names contain a forward slash.
|
|
541
550
|
|
|
542
551
|
:param str acquisition_id: 24-character hex ID (required)
|
|
543
552
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -555,9 +564,7 @@ class Flywheel:
|
|
|
555
564
|
|
|
556
565
|
|
|
557
566
|
def get_acquisition_analysis_output_download_url(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
558
|
-
"""
|
|
559
|
-
|
|
560
|
-
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
567
|
+
"""Get a signed URL to download a named child file.
|
|
561
568
|
|
|
562
569
|
:param str acquisition_id: 24-character hex ID (required)
|
|
563
570
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -609,6 +616,7 @@ class Flywheel:
|
|
|
609
616
|
:param bool inflate_job:
|
|
610
617
|
:param bool join_avatars:
|
|
611
618
|
:param JoinType join:
|
|
619
|
+
:param bool include_all_info: Include all info in returned objects
|
|
612
620
|
:param list[str] x_accept_feature:
|
|
613
621
|
:param bool async_: Perform the request asynchronously
|
|
614
622
|
:return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
@@ -680,6 +688,7 @@ class Flywheel:
|
|
|
680
688
|
:param JoinType join:
|
|
681
689
|
:param bool join_avatars: add name and avatar to notes
|
|
682
690
|
:param str collection_id:
|
|
691
|
+
:param bool include_all_info: Include all info in returned objects
|
|
683
692
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
684
693
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
685
694
|
:param int limit: The maximum number of entries to return.
|
|
@@ -765,7 +774,7 @@ class Flywheel:
|
|
|
765
774
|
def modify_acquisition_info(self, cid, body, **kwargs): # noqa: E501
|
|
766
775
|
"""Update or replace info for a(n) acquisition.
|
|
767
776
|
|
|
768
|
-
Update or replace info for a(n) acquisition.
|
|
777
|
+
Update or replace info for a(n) acquisition. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
769
778
|
|
|
770
779
|
:param str cid: (required)
|
|
771
780
|
:param Info body: (required)
|
|
@@ -882,7 +891,7 @@ class Flywheel:
|
|
|
882
891
|
def delete_analyses_by_ids(self, body, **kwargs): # noqa: E501
|
|
883
892
|
"""Delete multiple analyses by ID list
|
|
884
893
|
|
|
885
|
-
Delete analyses by
|
|
894
|
+
Delete multiple analyses by ID list
|
|
886
895
|
|
|
887
896
|
:param list[str] body: List of IDs to delete (required)
|
|
888
897
|
:param ContainerDeleteReason delete_reason:
|
|
@@ -892,6 +901,19 @@ class Flywheel:
|
|
|
892
901
|
return self.analyses_api.delete_analyses_by_ids(body, **kwargs)
|
|
893
902
|
|
|
894
903
|
|
|
904
|
+
def delete_analyses_by_query(self, body, **kwargs): # noqa: E501
|
|
905
|
+
"""Delete multiple analyses by query
|
|
906
|
+
|
|
907
|
+
Delete multiple analyses by query
|
|
908
|
+
|
|
909
|
+
:param list[Filter] body: Query for containers to delete (required)
|
|
910
|
+
:param ContainerDeleteReason delete_reason:
|
|
911
|
+
:param bool async_: Perform the request asynchronously
|
|
912
|
+
:return: DeletedResult
|
|
913
|
+
"""
|
|
914
|
+
return self.analyses_api.delete_analyses_by_query(body, **kwargs)
|
|
915
|
+
|
|
916
|
+
|
|
895
917
|
def delete_analysis(self, analysis_id, **kwargs): # noqa: E501
|
|
896
918
|
"""Delete an analysis
|
|
897
919
|
|
|
@@ -951,9 +973,9 @@ class Flywheel:
|
|
|
951
973
|
|
|
952
974
|
|
|
953
975
|
def get_analysis_input_zip_info(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
954
|
-
"""
|
|
976
|
+
"""Retrieve the zip info of a child file by name.
|
|
955
977
|
|
|
956
|
-
|
|
978
|
+
Does not work on files whose names contain a forward slash.
|
|
957
979
|
|
|
958
980
|
:param str analysis_id: 24-character hex ID (required)
|
|
959
981
|
:param str filename: input filename (required)
|
|
@@ -970,9 +992,7 @@ class Flywheel:
|
|
|
970
992
|
|
|
971
993
|
|
|
972
994
|
def get_analysis_input_download_url(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
973
|
-
"""
|
|
974
|
-
|
|
975
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
995
|
+
"""Get a signed URL to download a named child file.
|
|
976
996
|
|
|
977
997
|
:param str analysis_id: 24-character hex ID (required)
|
|
978
998
|
:param str filename: input filename (required)
|
|
@@ -1013,9 +1033,9 @@ class Flywheel:
|
|
|
1013
1033
|
|
|
1014
1034
|
|
|
1015
1035
|
def get_analysis_output_zip_info(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
1016
|
-
"""
|
|
1036
|
+
"""Retrieve the zip info of a child file by name.
|
|
1017
1037
|
|
|
1018
|
-
|
|
1038
|
+
Does not work on files whose names contain a forward slash.
|
|
1019
1039
|
|
|
1020
1040
|
:param str analysis_id: Container ID (required)
|
|
1021
1041
|
:param str filename: output file name (required)
|
|
@@ -1032,9 +1052,7 @@ class Flywheel:
|
|
|
1032
1052
|
|
|
1033
1053
|
|
|
1034
1054
|
def get_analysis_output_download_url(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
1035
|
-
"""Get
|
|
1036
|
-
|
|
1037
|
-
Get Output File
|
|
1055
|
+
"""Get a signed URL to download a named child file.
|
|
1038
1056
|
|
|
1039
1057
|
:param str analysis_id: Container ID (required)
|
|
1040
1058
|
:param str filename: output file name (required)
|
|
@@ -1061,6 +1079,7 @@ class Flywheel:
|
|
|
1061
1079
|
Returns a page of analyses Args: filter (t.Optional[str]): The filters to apply sort (t.List[Tuple[str,int]): Sorting, as a list of (str, int) tuples limit (t.Optional[int]): The maximum number of entries to return skip (t.Optional[int]): The number of entries to skip page (t.Optional[int]): Page number after_id (t.Optional[str]): Id to return results after Returns: Page: if a above argument is not None
|
|
1062
1080
|
|
|
1063
1081
|
:param bool inflate_job: Return job as an object instead of an id
|
|
1082
|
+
:param bool include_all_info: Include all info in returned objects
|
|
1064
1083
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
1065
1084
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
1066
1085
|
:param int limit: The maximum number of entries to return.
|
|
@@ -1158,7 +1177,7 @@ class Flywheel:
|
|
|
1158
1177
|
def modify_analysis_info(self, container_id, body, **kwargs): # noqa: E501
|
|
1159
1178
|
"""Update or replace info for a(n) analysis.
|
|
1160
1179
|
|
|
1161
|
-
Update or replace info for a(n) analysis.
|
|
1180
|
+
Update or replace info for a(n) analysis. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
1162
1181
|
|
|
1163
1182
|
:param str container_id: (required)
|
|
1164
1183
|
:param Info body: (required)
|
|
@@ -1337,7 +1356,6 @@ class Flywheel:
|
|
|
1337
1356
|
def get_batch(self, batch_id, **kwargs): # noqa: E501
|
|
1338
1357
|
"""Get batch job details.
|
|
1339
1358
|
|
|
1340
|
-
|
|
1341
1359
|
:param str batch_id: (required)
|
|
1342
1360
|
:param bool jobs: If true, return job objects instead of job ids
|
|
1343
1361
|
:param bool async_: Perform the request asynchronously
|
|
@@ -1385,7 +1403,6 @@ class Flywheel:
|
|
|
1385
1403
|
def get_change_log(self, container_type, container_id, **kwargs): # noqa: E501
|
|
1386
1404
|
"""Get Change Log
|
|
1387
1405
|
|
|
1388
|
-
|
|
1389
1406
|
:param ChangeLogContainerType container_type: (required)
|
|
1390
1407
|
:param str container_id: (required)
|
|
1391
1408
|
:param int version: Optional version if retrieving logs for file
|
|
@@ -1398,7 +1415,6 @@ class Flywheel:
|
|
|
1398
1415
|
def get_field_change_log(self, container_type, container_id, field, **kwargs): # noqa: E501
|
|
1399
1416
|
"""Get change logs by specific field, in reverse chronological order
|
|
1400
1417
|
|
|
1401
|
-
|
|
1402
1418
|
:param ChangeLogContainerType container_type: (required)
|
|
1403
1419
|
:param str container_id: (required)
|
|
1404
1420
|
:param str field: (required)
|
|
@@ -1565,6 +1581,19 @@ class Flywheel:
|
|
|
1565
1581
|
return self.collections_api.delete_collections_by_ids(body, **kwargs)
|
|
1566
1582
|
|
|
1567
1583
|
|
|
1584
|
+
def delete_collections_by_query(self, body, **kwargs): # noqa: E501
|
|
1585
|
+
"""Delete multiple collections by query
|
|
1586
|
+
|
|
1587
|
+
Delete multiple collections by query
|
|
1588
|
+
|
|
1589
|
+
:param list[Filter] body: Query for containers to delete (required)
|
|
1590
|
+
:param ContainerDeleteReason delete_reason:
|
|
1591
|
+
:param bool async_: Perform the request asynchronously
|
|
1592
|
+
:return: DeletedResult
|
|
1593
|
+
"""
|
|
1594
|
+
return self.collections_api.delete_collections_by_query(body, **kwargs)
|
|
1595
|
+
|
|
1596
|
+
|
|
1568
1597
|
def download_file_from_collection(self, collection_id, file_name, dest_file, **kwargs): # noqa: E501
|
|
1569
1598
|
"""Download a file.
|
|
1570
1599
|
|
|
@@ -1587,9 +1616,9 @@ class Flywheel:
|
|
|
1587
1616
|
|
|
1588
1617
|
|
|
1589
1618
|
def get_collection_file_zip_info(self, collection_id, file_name, **kwargs): # noqa: E501
|
|
1590
|
-
"""
|
|
1619
|
+
"""Retrieve the zip info of a child file by name.
|
|
1591
1620
|
|
|
1592
|
-
|
|
1621
|
+
Does not work on files whose names contain a forward slash.
|
|
1593
1622
|
|
|
1594
1623
|
:param str collection_id: 24-character hex ID (required)
|
|
1595
1624
|
:param str file_name: output file name (required)
|
|
@@ -1608,9 +1637,7 @@ class Flywheel:
|
|
|
1608
1637
|
|
|
1609
1638
|
|
|
1610
1639
|
def get_collection_download_url(self, collection_id, file_name, **kwargs): # noqa: E501
|
|
1611
|
-
"""
|
|
1612
|
-
|
|
1613
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1640
|
+
"""Get a signed URL to download a named child file.
|
|
1614
1641
|
|
|
1615
1642
|
:param str collection_id: 24-character hex ID (required)
|
|
1616
1643
|
:param str file_name: output file name (required)
|
|
@@ -1643,6 +1670,7 @@ class Flywheel:
|
|
|
1643
1670
|
:param bool join_files:
|
|
1644
1671
|
:param JoinType join:
|
|
1645
1672
|
:param bool stats:
|
|
1673
|
+
:param bool include_all_info: Include all info in returned objects
|
|
1646
1674
|
:param str user_id:
|
|
1647
1675
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
1648
1676
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
@@ -1741,6 +1769,7 @@ class Flywheel:
|
|
|
1741
1769
|
List sessions in a collection.
|
|
1742
1770
|
|
|
1743
1771
|
:param str collection_id: (required)
|
|
1772
|
+
:param bool include_all_info: Include all info in returned objects
|
|
1744
1773
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
1745
1774
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
1746
1775
|
:param int limit: The maximum number of entries to return.
|
|
@@ -1838,7 +1867,7 @@ class Flywheel:
|
|
|
1838
1867
|
def modify_collection_info(self, cid, body, **kwargs): # noqa: E501
|
|
1839
1868
|
"""Update or replace info for a(n) collection.
|
|
1840
1869
|
|
|
1841
|
-
Update or replace info for a(n) collection.
|
|
1870
|
+
Update or replace info for a(n) collection. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
1842
1871
|
|
|
1843
1872
|
:param str cid: (required)
|
|
1844
1873
|
:param Info body: (required)
|
|
@@ -2147,9 +2176,9 @@ class Flywheel:
|
|
|
2147
2176
|
|
|
2148
2177
|
|
|
2149
2178
|
def get_container_file_zip_info(self, container_id, file_name, **kwargs): # noqa: E501
|
|
2150
|
-
"""
|
|
2179
|
+
"""Retrieve the zip info of a child file by name.
|
|
2151
2180
|
|
|
2152
|
-
|
|
2181
|
+
Does not work on files whose names contain a forward slash.
|
|
2153
2182
|
|
|
2154
2183
|
:param str container_id: 24-character hex ID (required)
|
|
2155
2184
|
:param str file_name: output file name (required)
|
|
@@ -2168,9 +2197,7 @@ class Flywheel:
|
|
|
2168
2197
|
|
|
2169
2198
|
|
|
2170
2199
|
def get_container_download_url(self, container_id, file_name, **kwargs): # noqa: E501
|
|
2171
|
-
"""
|
|
2172
|
-
|
|
2173
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
2200
|
+
"""Get a signed URL to download a named child file.
|
|
2174
2201
|
|
|
2175
2202
|
:param str container_id: 24-character hex ID (required)
|
|
2176
2203
|
:param str file_name: output file name (required)
|
|
@@ -2214,9 +2241,9 @@ class Flywheel:
|
|
|
2214
2241
|
|
|
2215
2242
|
|
|
2216
2243
|
def get_container_analysis_input_zip_info(self, container_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2217
|
-
"""
|
|
2244
|
+
"""Retrieve the zip info of a child file by name.
|
|
2218
2245
|
|
|
2219
|
-
|
|
2246
|
+
Does not work on files whose names contain a forward slash.
|
|
2220
2247
|
|
|
2221
2248
|
:param str container_id: 24-character hex ID (required)
|
|
2222
2249
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -2234,9 +2261,7 @@ class Flywheel:
|
|
|
2234
2261
|
|
|
2235
2262
|
|
|
2236
2263
|
def get_container_analysis_input_download_url(self, container_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2237
|
-
"""
|
|
2238
|
-
|
|
2239
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
2264
|
+
"""Get a signed URL to download a named child file.
|
|
2240
2265
|
|
|
2241
2266
|
:param str container_id: 24-character hex ID (required)
|
|
2242
2267
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -2279,9 +2304,9 @@ class Flywheel:
|
|
|
2279
2304
|
|
|
2280
2305
|
|
|
2281
2306
|
def get_container_analysis_output_zip_info(self, container_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2282
|
-
"""
|
|
2307
|
+
"""Retrieve the zip info of a child file by name.
|
|
2283
2308
|
|
|
2284
|
-
|
|
2309
|
+
Does not work on files whose names contain a forward slash.
|
|
2285
2310
|
|
|
2286
2311
|
:param str container_id: 24-character hex ID (required)
|
|
2287
2312
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -2299,9 +2324,7 @@ class Flywheel:
|
|
|
2299
2324
|
|
|
2300
2325
|
|
|
2301
2326
|
def get_container_analysis_output_download_url(self, container_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2302
|
-
"""
|
|
2303
|
-
|
|
2304
|
-
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2327
|
+
"""Get a signed URL to download a named child file.
|
|
2305
2328
|
|
|
2306
2329
|
:param str container_id: 24-character hex ID (required)
|
|
2307
2330
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -2352,6 +2375,7 @@ class Flywheel:
|
|
|
2352
2375
|
:param bool inflate_job:
|
|
2353
2376
|
:param bool join_avatars:
|
|
2354
2377
|
:param JoinType join:
|
|
2378
|
+
:param bool include_all_info: Include all info in returned objects
|
|
2355
2379
|
:param list[str] x_accept_feature:
|
|
2356
2380
|
:param bool async_: Perform the request asynchronously
|
|
2357
2381
|
:return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
@@ -2504,7 +2528,7 @@ class Flywheel:
|
|
|
2504
2528
|
def modify_container_info(self, cid, body, **kwargs): # noqa: E501
|
|
2505
2529
|
"""Update or replace info for a(n) container.
|
|
2506
2530
|
|
|
2507
|
-
Update or replace info for a(n) container.
|
|
2531
|
+
Update or replace info for a(n) container. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
2508
2532
|
|
|
2509
2533
|
:param str cid: (required)
|
|
2510
2534
|
:param Info body: (required)
|
|
@@ -2595,7 +2619,6 @@ class Flywheel:
|
|
|
2595
2619
|
def delete_view_execution(self, data_view_execution_id, **kwargs): # noqa: E501
|
|
2596
2620
|
"""Delete a data_view_execution
|
|
2597
2621
|
|
|
2598
|
-
|
|
2599
2622
|
:param str data_view_execution_id: (required)
|
|
2600
2623
|
:param bool async_: Perform the request asynchronously
|
|
2601
2624
|
:return: DeletedResult
|
|
@@ -2606,7 +2629,6 @@ class Flywheel:
|
|
|
2606
2629
|
def get_all_data_view_executions(self, **kwargs): # noqa: E501
|
|
2607
2630
|
"""Get a list of data_view_executions
|
|
2608
2631
|
|
|
2609
|
-
|
|
2610
2632
|
:param bool exhaustive: Set to return a complete list regardless of permissions
|
|
2611
2633
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
2612
2634
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
@@ -2624,7 +2646,6 @@ class Flywheel:
|
|
|
2624
2646
|
def get_data_view_execution(self, data_view_execution_id, **kwargs): # noqa: E501
|
|
2625
2647
|
"""Get a single data_view_execution
|
|
2626
2648
|
|
|
2627
|
-
|
|
2628
2649
|
:param str data_view_execution_id: (required)
|
|
2629
2650
|
:param bool async_: Perform the request asynchronously
|
|
2630
2651
|
:return: DataViewExecution
|
|
@@ -2635,7 +2656,6 @@ class Flywheel:
|
|
|
2635
2656
|
def get_data_view_execution_data(self, data_view_execution_id, **kwargs): # noqa: E501
|
|
2636
2657
|
"""Get the data from a data_view_execution
|
|
2637
2658
|
|
|
2638
|
-
|
|
2639
2659
|
:param str data_view_execution_id: (required)
|
|
2640
2660
|
:param str ticket: download ticket id
|
|
2641
2661
|
:param FileFormat file_format:
|
|
@@ -2649,7 +2669,6 @@ class Flywheel:
|
|
|
2649
2669
|
def save_data_view_execution(self, data_view_execution_id, **kwargs): # noqa: E501
|
|
2650
2670
|
"""Save a data_view_execution to a project
|
|
2651
2671
|
|
|
2652
|
-
|
|
2653
2672
|
:param str data_view_execution_id: (required)
|
|
2654
2673
|
:param FileFormat file_format:
|
|
2655
2674
|
:param bool async_: Perform the request asynchronously
|
|
@@ -2661,7 +2680,6 @@ class Flywheel:
|
|
|
2661
2680
|
def delete_save_search(self, search_id, **kwargs): # noqa: E501
|
|
2662
2681
|
"""Delete a saved search
|
|
2663
2682
|
|
|
2664
|
-
|
|
2665
2683
|
:param str search_id: (required)
|
|
2666
2684
|
:param bool async_: Perform the request asynchronously
|
|
2667
2685
|
:return: DeletedResult
|
|
@@ -2672,7 +2690,6 @@ class Flywheel:
|
|
|
2672
2690
|
def get_all_saved_searches(self, **kwargs): # noqa: E501
|
|
2673
2691
|
"""Get Queries
|
|
2674
2692
|
|
|
2675
|
-
|
|
2676
2693
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
2677
2694
|
:param str sort: The sort fields and order.(e.g. label:asc,created:desc)
|
|
2678
2695
|
:param int limit: The maximum number of entries to return
|
|
@@ -2690,7 +2707,6 @@ class Flywheel:
|
|
|
2690
2707
|
def get_saved_search(self, sid, **kwargs): # noqa: E501
|
|
2691
2708
|
"""Return a saved search query
|
|
2692
2709
|
|
|
2693
|
-
|
|
2694
2710
|
:param str sid: (required)
|
|
2695
2711
|
:param bool async_: Perform the request asynchronously
|
|
2696
2712
|
:return: SaveSearch
|
|
@@ -2713,7 +2729,6 @@ class Flywheel:
|
|
|
2713
2729
|
def get_search_status(self, **kwargs): # noqa: E501
|
|
2714
2730
|
"""Get the status of search (Mongo Connector)
|
|
2715
2731
|
|
|
2716
|
-
|
|
2717
2732
|
:param bool async_: Perform the request asynchronously
|
|
2718
2733
|
:return: SearchStatus
|
|
2719
2734
|
"""
|
|
@@ -2735,7 +2750,6 @@ class Flywheel:
|
|
|
2735
2750
|
def replace_search(self, sid, body, **kwargs): # noqa: E501
|
|
2736
2751
|
"""Replace a search query
|
|
2737
2752
|
|
|
2738
|
-
|
|
2739
2753
|
:param str sid: (required)
|
|
2740
2754
|
:param SaveSearchUpdate body: (required)
|
|
2741
2755
|
:param bool async_: Perform the request asynchronously
|
|
@@ -2747,7 +2761,6 @@ class Flywheel:
|
|
|
2747
2761
|
def save_search(self, body, **kwargs): # noqa: E501
|
|
2748
2762
|
"""Save a search query
|
|
2749
2763
|
|
|
2750
|
-
|
|
2751
2764
|
:param SaveSearchInput body: (required)
|
|
2752
2765
|
:param bool async_: Perform the request asynchronously
|
|
2753
2766
|
:return: InsertedId
|
|
@@ -2758,7 +2771,6 @@ class Flywheel:
|
|
|
2758
2771
|
def search(self, body, **kwargs): # noqa: E501
|
|
2759
2772
|
"""Perform a search query
|
|
2760
2773
|
|
|
2761
|
-
|
|
2762
2774
|
:param SearchQuery body: (required)
|
|
2763
2775
|
:param bool simple: Unwrap result documents into a list.
|
|
2764
2776
|
:param int size: The maximum number of results to return.
|
|
@@ -2797,7 +2809,6 @@ class Flywheel:
|
|
|
2797
2809
|
def delete_device_key(self, device_id, key_id, **kwargs): # noqa: E501
|
|
2798
2810
|
"""Delete Device Key
|
|
2799
2811
|
|
|
2800
|
-
|
|
2801
2812
|
:param str device_id: (required)
|
|
2802
2813
|
:param str key_id: (required)
|
|
2803
2814
|
:param bool async_: Perform the request asynchronously
|
|
@@ -2850,7 +2861,6 @@ class Flywheel:
|
|
|
2850
2861
|
def get_device(self, device_id, **kwargs): # noqa: E501
|
|
2851
2862
|
"""Get device details
|
|
2852
2863
|
|
|
2853
|
-
|
|
2854
2864
|
:param str device_id: (required)
|
|
2855
2865
|
:param bool async_: Perform the request asynchronously
|
|
2856
2866
|
:return: EgressDevice
|
|
@@ -3063,9 +3073,9 @@ class Flywheel:
|
|
|
3063
3073
|
|
|
3064
3074
|
|
|
3065
3075
|
def delete_files_by_ids(self, body, **kwargs): # noqa: E501
|
|
3066
|
-
"""Delete
|
|
3076
|
+
"""Delete multiple files by ID list
|
|
3067
3077
|
|
|
3068
|
-
Delete multiple files by
|
|
3078
|
+
Delete multiple files by ID list
|
|
3069
3079
|
|
|
3070
3080
|
:param list[str] body: List of IDs to delete (required)
|
|
3071
3081
|
:param ContainerDeleteReason delete_reason:
|
|
@@ -3075,6 +3085,19 @@ class Flywheel:
|
|
|
3075
3085
|
return self.files_api.delete_files_by_ids(body, **kwargs)
|
|
3076
3086
|
|
|
3077
3087
|
|
|
3088
|
+
def delete_files_by_query(self, body, **kwargs): # noqa: E501
|
|
3089
|
+
"""Delete multiple files by query
|
|
3090
|
+
|
|
3091
|
+
Delete multiple files by query
|
|
3092
|
+
|
|
3093
|
+
:param list[Filter] body: Query for containers to delete (required)
|
|
3094
|
+
:param ContainerDeleteReason delete_reason:
|
|
3095
|
+
:param bool async_: Perform the request asynchronously
|
|
3096
|
+
:return: DeletedResult
|
|
3097
|
+
"""
|
|
3098
|
+
return self.files_api.delete_files_by_query(body, **kwargs)
|
|
3099
|
+
|
|
3100
|
+
|
|
3078
3101
|
def get_all_files(self, **kwargs): # noqa: E501
|
|
3079
3102
|
"""Return all files
|
|
3080
3103
|
|
|
@@ -3130,6 +3153,20 @@ class Flywheel:
|
|
|
3130
3153
|
return self.files_api.get_file_versions(file_id, **kwargs)
|
|
3131
3154
|
|
|
3132
3155
|
|
|
3156
|
+
def get_file_zip_info(self, file_id, **kwargs): # noqa: E501
|
|
3157
|
+
"""Get Zip Info
|
|
3158
|
+
|
|
3159
|
+
Get info on zipfile
|
|
3160
|
+
|
|
3161
|
+
:param str file_id: (required)
|
|
3162
|
+
:param int version:
|
|
3163
|
+
:param str ticket:
|
|
3164
|
+
:param bool async_: Perform the request asynchronously
|
|
3165
|
+
:return: ZipfileInfo
|
|
3166
|
+
"""
|
|
3167
|
+
return self.files_api.get_file_zip_info(file_id, **kwargs)
|
|
3168
|
+
|
|
3169
|
+
|
|
3133
3170
|
def move_file(self, file_id, body, **kwargs): # noqa: E501
|
|
3134
3171
|
"""Move and/or rename a file
|
|
3135
3172
|
|
|
@@ -3199,7 +3236,6 @@ class Flywheel:
|
|
|
3199
3236
|
def add_gear_permission(self, gear_name, permission_type, body, **kwargs): # noqa: E501
|
|
3200
3237
|
"""Add an individual permission to the given gear
|
|
3201
3238
|
|
|
3202
|
-
|
|
3203
3239
|
:param str gear_name: Name of the gear to interact with (required)
|
|
3204
3240
|
:param GearPermissionsType permission_type: (required)
|
|
3205
3241
|
:param GearPermissionsInput body: (required)
|
|
@@ -3212,7 +3248,6 @@ class Flywheel:
|
|
|
3212
3248
|
def delete_gear(self, gear_id, **kwargs): # noqa: E501
|
|
3213
3249
|
"""Delete a gear (not recommended)
|
|
3214
3250
|
|
|
3215
|
-
|
|
3216
3251
|
:param str gear_id: Id of the gear to interact with (required)
|
|
3217
3252
|
:param bool async_: Perform the request asynchronously
|
|
3218
3253
|
:return: None
|
|
@@ -3223,7 +3258,6 @@ class Flywheel:
|
|
|
3223
3258
|
def delete_gear_permission(self, gear_name, permission_type, permission_id, **kwargs): # noqa: E501
|
|
3224
3259
|
"""Delete an individual permission of the given gear
|
|
3225
3260
|
|
|
3226
|
-
|
|
3227
3261
|
:param str gear_name: (required)
|
|
3228
3262
|
:param GearPermissionsType permission_type: (required)
|
|
3229
3263
|
:param str permission_id: (required)
|
|
@@ -3236,7 +3270,6 @@ class Flywheel:
|
|
|
3236
3270
|
def delete_gear_permissions(self, gear_name, **kwargs): # noqa: E501
|
|
3237
3271
|
"""Delete permissions of the given gear
|
|
3238
3272
|
|
|
3239
|
-
|
|
3240
3273
|
:param str gear_name: (required)
|
|
3241
3274
|
:param bool async_: Perform the request asynchronously
|
|
3242
3275
|
:return: None
|
|
@@ -3319,7 +3352,6 @@ class Flywheel:
|
|
|
3319
3352
|
def get_gear_suggest(self, gear_id, container_name, container_id, **kwargs): # noqa: E501
|
|
3320
3353
|
"""Get files with input suggestions, parent containers, and child containers for the given container.
|
|
3321
3354
|
|
|
3322
|
-
|
|
3323
3355
|
:param str gear_id: Id of the gear to interact with (required)
|
|
3324
3356
|
:param str container_name: Type of the container to interact with (required)
|
|
3325
3357
|
:param str container_id: Id of the container to interact with (required)
|
|
@@ -3339,7 +3371,6 @@ class Flywheel:
|
|
|
3339
3371
|
def get_gear_ticket(self, ticket_id, **kwargs): # noqa: E501
|
|
3340
3372
|
"""Retrieve a specific gear ticket
|
|
3341
3373
|
|
|
3342
|
-
|
|
3343
3374
|
:param str ticket_id: (required)
|
|
3344
3375
|
:param bool async_: Perform the request asynchronously
|
|
3345
3376
|
:return: GearTicket
|
|
@@ -3350,7 +3381,6 @@ class Flywheel:
|
|
|
3350
3381
|
def get_my_gear_tickets(self, **kwargs): # noqa: E501
|
|
3351
3382
|
"""Retrieve all gear tickets for the current user
|
|
3352
3383
|
|
|
3353
|
-
|
|
3354
3384
|
:param bool async_: Perform the request asynchronously
|
|
3355
3385
|
:return: list[str]
|
|
3356
3386
|
"""
|
|
@@ -3360,7 +3390,6 @@ class Flywheel:
|
|
|
3360
3390
|
def modify_gear_series(self, gear_name, body, **kwargs): # noqa: E501
|
|
3361
3391
|
"""Update a gear series
|
|
3362
3392
|
|
|
3363
|
-
|
|
3364
3393
|
:param str gear_name: Name of the gear series to modify (required)
|
|
3365
3394
|
:param GearSeriesUpdate body: (required)
|
|
3366
3395
|
:param bool async_: Perform the request asynchronously
|
|
@@ -3384,7 +3413,6 @@ class Flywheel:
|
|
|
3384
3413
|
def replace_gear_permissions(self, gear_name, body, **kwargs): # noqa: E501
|
|
3385
3414
|
"""Replace permissions for the given gear
|
|
3386
3415
|
|
|
3387
|
-
|
|
3388
3416
|
:param str gear_name: Name of the gear to interact with (required)
|
|
3389
3417
|
:param GearPermissions body: (required)
|
|
3390
3418
|
:param bool async_: Perform the request asynchronously
|
|
@@ -3563,6 +3591,19 @@ class Flywheel:
|
|
|
3563
3591
|
return self.groups_api.delete_groups_by_ids(body, **kwargs)
|
|
3564
3592
|
|
|
3565
3593
|
|
|
3594
|
+
def delete_groups_by_query(self, body, **kwargs): # noqa: E501
|
|
3595
|
+
"""Delete multiple groups by query
|
|
3596
|
+
|
|
3597
|
+
Delete multiple groups by query
|
|
3598
|
+
|
|
3599
|
+
:param list[Filter] body: Query for containers to delete (required)
|
|
3600
|
+
:param ContainerDeleteReason delete_reason:
|
|
3601
|
+
:param bool async_: Perform the request asynchronously
|
|
3602
|
+
:return: DeletedResult
|
|
3603
|
+
"""
|
|
3604
|
+
return self.groups_api.delete_groups_by_query(body, **kwargs)
|
|
3605
|
+
|
|
3606
|
+
|
|
3566
3607
|
def get_all_group_roles(self, group_id, **kwargs): # noqa: E501
|
|
3567
3608
|
"""Get list of group roles
|
|
3568
3609
|
|
|
@@ -3613,6 +3654,7 @@ class Flywheel:
|
|
|
3613
3654
|
|
|
3614
3655
|
:param str group_id: (required)
|
|
3615
3656
|
:param bool exhaustive:
|
|
3657
|
+
:param bool include_all_info: Include all info in returned objects
|
|
3616
3658
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
3617
3659
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3618
3660
|
:param int limit: The maximum number of entries to return.
|
|
@@ -3763,7 +3805,6 @@ class Flywheel:
|
|
|
3763
3805
|
def add_job_logs(self, job_id, body, **kwargs): # noqa: E501
|
|
3764
3806
|
"""Add logs to a job.
|
|
3765
3807
|
|
|
3766
|
-
|
|
3767
3808
|
:param str job_id: (required)
|
|
3768
3809
|
:param list[JobLog] body: (required)
|
|
3769
3810
|
:param bool async_: Perform the request asynchronously
|
|
@@ -3800,7 +3841,6 @@ class Flywheel:
|
|
|
3800
3841
|
def complete_job(self, job_id, body, **kwargs): # noqa: E501
|
|
3801
3842
|
"""Complete a job, with information
|
|
3802
3843
|
|
|
3803
|
-
|
|
3804
3844
|
:param str job_id: (required)
|
|
3805
3845
|
:param JobComplete body: (required)
|
|
3806
3846
|
:param str job_ticket_id: ticket id for job completion
|
|
@@ -3813,7 +3853,6 @@ class Flywheel:
|
|
|
3813
3853
|
def determine_provider_for_job(self, body, **kwargs): # noqa: E501
|
|
3814
3854
|
"""Determine the effective compute provider for a proposed job.
|
|
3815
3855
|
|
|
3816
|
-
|
|
3817
3856
|
:param InputJob body: (required)
|
|
3818
3857
|
:param bool async_: Perform the request asynchronously
|
|
3819
3858
|
:return: Provider
|
|
@@ -3824,7 +3863,6 @@ class Flywheel:
|
|
|
3824
3863
|
def get_all_jobs(self, **kwargs): # noqa: E501
|
|
3825
3864
|
"""Return all jobs
|
|
3826
3865
|
|
|
3827
|
-
|
|
3828
3866
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
3829
3867
|
:param str sort: The sort fields and order.(e.g. label:asc,created:desc)
|
|
3830
3868
|
:param int limit: The maximum number of entries to return
|
|
@@ -3832,6 +3870,7 @@ class Flywheel:
|
|
|
3832
3870
|
:param int page: The page number (i.e. skip limit*page entries)
|
|
3833
3871
|
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3834
3872
|
:param bool include_parent_info: Include the parent info for the jobs
|
|
3873
|
+
:param bool include_all_info: Include all info in returned objects
|
|
3835
3874
|
:param list[str] x_accept_feature:
|
|
3836
3875
|
:param bool async_: Perform the request asynchronously
|
|
3837
3876
|
:return: union[list[JobListOutput],Page]
|
|
@@ -3842,7 +3881,6 @@ class Flywheel:
|
|
|
3842
3881
|
def get_job(self, job_id, **kwargs): # noqa: E501
|
|
3843
3882
|
"""Get job details
|
|
3844
3883
|
|
|
3845
|
-
|
|
3846
3884
|
:param str job_id: (required)
|
|
3847
3885
|
:param bool async_: Perform the request asynchronously
|
|
3848
3886
|
:return: JobOutput
|
|
@@ -3853,7 +3891,6 @@ class Flywheel:
|
|
|
3853
3891
|
def get_job_config(self, job_id, **kwargs): # noqa: E501
|
|
3854
3892
|
"""Get a job's config
|
|
3855
3893
|
|
|
3856
|
-
|
|
3857
3894
|
:param str job_id: (required)
|
|
3858
3895
|
:param bool async_: Perform the request asynchronously
|
|
3859
3896
|
:return: JobOutputConfig
|
|
@@ -3864,7 +3901,6 @@ class Flywheel:
|
|
|
3864
3901
|
def get_job_detail(self, job_id, **kwargs): # noqa: E501
|
|
3865
3902
|
"""Get job container details
|
|
3866
3903
|
|
|
3867
|
-
|
|
3868
3904
|
:param str job_id: (required)
|
|
3869
3905
|
:param bool async_: Perform the request asynchronously
|
|
3870
3906
|
:return: JobDetail
|
|
@@ -3875,7 +3911,6 @@ class Flywheel:
|
|
|
3875
3911
|
def get_job_logs(self, job_id, **kwargs): # noqa: E501
|
|
3876
3912
|
"""Get job logs
|
|
3877
3913
|
|
|
3878
|
-
|
|
3879
3914
|
:param str job_id: (required)
|
|
3880
3915
|
:param bool async_: Perform the request asynchronously
|
|
3881
3916
|
:return: JobLogRecord
|
|
@@ -3886,7 +3921,6 @@ class Flywheel:
|
|
|
3886
3921
|
def get_jobs_stats(self, **kwargs): # noqa: E501
|
|
3887
3922
|
"""Get stats about all current jobs
|
|
3888
3923
|
|
|
3889
|
-
|
|
3890
3924
|
:param bool async_: Perform the request asynchronously
|
|
3891
3925
|
:return: object
|
|
3892
3926
|
"""
|
|
@@ -3922,7 +3956,6 @@ class Flywheel:
|
|
|
3922
3956
|
def prepare_complete_job(self, job_id, **kwargs): # noqa: E501
|
|
3923
3957
|
"""Create a ticket for completing a job, with id and status.
|
|
3924
3958
|
|
|
3925
|
-
|
|
3926
3959
|
:param str job_id: (required)
|
|
3927
3960
|
:param bool async_: Perform the request asynchronously
|
|
3928
3961
|
:return: JobTicketOutput
|
|
@@ -3933,7 +3966,6 @@ class Flywheel:
|
|
|
3933
3966
|
def reap_jobs(self, **kwargs): # noqa: E501
|
|
3934
3967
|
"""Reap stale jobs
|
|
3935
3968
|
|
|
3936
|
-
|
|
3937
3969
|
:param bool async_: Perform the request asynchronously
|
|
3938
3970
|
:return: OrphanedCount
|
|
3939
3971
|
"""
|
|
@@ -3970,7 +4002,6 @@ class Flywheel:
|
|
|
3970
4002
|
def update_jobs_priority(self, body, **kwargs): # noqa: E501
|
|
3971
4003
|
"""Update a job priority.
|
|
3972
4004
|
|
|
3973
|
-
|
|
3974
4005
|
:param JobPriorityUpdate body: (required)
|
|
3975
4006
|
:param bool async_: Perform the request asynchronously
|
|
3976
4007
|
:return: ModifiedResult
|
|
@@ -4018,7 +4049,6 @@ class Flywheel:
|
|
|
4018
4049
|
def delete_modality(self, modality_id, **kwargs): # noqa: E501
|
|
4019
4050
|
"""Delete a modality
|
|
4020
4051
|
|
|
4021
|
-
|
|
4022
4052
|
:param str modality_id: (required)
|
|
4023
4053
|
:param bool async_: Perform the request asynchronously
|
|
4024
4054
|
:return: DeletedResult
|
|
@@ -4047,7 +4077,6 @@ class Flywheel:
|
|
|
4047
4077
|
def get_modality(self, modality_id, **kwargs): # noqa: E501
|
|
4048
4078
|
"""Get a modality's classification specification
|
|
4049
4079
|
|
|
4050
|
-
|
|
4051
4080
|
:param str modality_id: (required)
|
|
4052
4081
|
:param bool async_: Perform the request asynchronously
|
|
4053
4082
|
:return: ModalityOutput
|
|
@@ -4058,7 +4087,6 @@ class Flywheel:
|
|
|
4058
4087
|
def replace_modality(self, modality_id, body, **kwargs): # noqa: E501
|
|
4059
4088
|
"""Replace modality
|
|
4060
4089
|
|
|
4061
|
-
|
|
4062
4090
|
:param str modality_id: (required)
|
|
4063
4091
|
:param ModalityModify body: (required)
|
|
4064
4092
|
:param bool async_: Perform the request asynchronously
|
|
@@ -4081,7 +4109,6 @@ class Flywheel:
|
|
|
4081
4109
|
def add_project(self, body, **kwargs): # noqa: E501
|
|
4082
4110
|
"""Create a new project
|
|
4083
4111
|
|
|
4084
|
-
|
|
4085
4112
|
:param ProjectInput body: (required)
|
|
4086
4113
|
:param bool inherit: Inherit permissions from the group permission template
|
|
4087
4114
|
:param bool async_: Perform the request asynchronously
|
|
@@ -4149,7 +4176,6 @@ class Flywheel:
|
|
|
4149
4176
|
def add_project_rule(self, project_id, body, **kwargs): # noqa: E501
|
|
4150
4177
|
"""Create a new rule for a project.
|
|
4151
4178
|
|
|
4152
|
-
|
|
4153
4179
|
:param str project_id: (required)
|
|
4154
4180
|
:param GearRuleInput body: (required)
|
|
4155
4181
|
:param bool async_: Perform the request asynchronously
|
|
@@ -4187,7 +4213,6 @@ class Flywheel:
|
|
|
4187
4213
|
def catalog_list(self, **kwargs): # noqa: E501
|
|
4188
4214
|
"""Catalog List
|
|
4189
4215
|
|
|
4190
|
-
|
|
4191
4216
|
:param str search_string: Include only results containing the search string
|
|
4192
4217
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
4193
4218
|
:param str sort: The sort fields and order.(e.g. label:asc,created:desc)
|
|
@@ -4300,7 +4325,6 @@ class Flywheel:
|
|
|
4300
4325
|
def delete_project_user_permission(self, project_id, uid, **kwargs): # noqa: E501
|
|
4301
4326
|
"""Delete a permission
|
|
4302
4327
|
|
|
4303
|
-
|
|
4304
4328
|
:param str project_id: (required)
|
|
4305
4329
|
:param str uid: (required)
|
|
4306
4330
|
:param list[union[HeaderFeature,str]] x_accept_feature:
|
|
@@ -4323,6 +4347,19 @@ class Flywheel:
|
|
|
4323
4347
|
return self.projects_api.delete_projects_by_ids(body, **kwargs)
|
|
4324
4348
|
|
|
4325
4349
|
|
|
4350
|
+
def delete_projects_by_query(self, body, **kwargs): # noqa: E501
|
|
4351
|
+
"""Delete multiple projects by query
|
|
4352
|
+
|
|
4353
|
+
Delete multiple projects by query
|
|
4354
|
+
|
|
4355
|
+
:param list[Filter] body: Query for containers to delete (required)
|
|
4356
|
+
:param ContainerDeleteReason delete_reason:
|
|
4357
|
+
:param bool async_: Perform the request asynchronously
|
|
4358
|
+
:return: DeletedResult
|
|
4359
|
+
"""
|
|
4360
|
+
return self.projects_api.delete_projects_by_query(body, **kwargs)
|
|
4361
|
+
|
|
4362
|
+
|
|
4326
4363
|
def download_file_from_project(self, project_id, file_name, dest_file, **kwargs): # noqa: E501
|
|
4327
4364
|
"""Download a file.
|
|
4328
4365
|
|
|
@@ -4345,9 +4382,9 @@ class Flywheel:
|
|
|
4345
4382
|
|
|
4346
4383
|
|
|
4347
4384
|
def get_project_file_zip_info(self, project_id, file_name, **kwargs): # noqa: E501
|
|
4348
|
-
"""
|
|
4385
|
+
"""Retrieve the zip info of a child file by name.
|
|
4349
4386
|
|
|
4350
|
-
|
|
4387
|
+
Does not work on files whose names contain a forward slash.
|
|
4351
4388
|
|
|
4352
4389
|
:param str project_id: 24-character hex ID (required)
|
|
4353
4390
|
:param str file_name: output file name (required)
|
|
@@ -4366,9 +4403,7 @@ class Flywheel:
|
|
|
4366
4403
|
|
|
4367
4404
|
|
|
4368
4405
|
def get_project_download_url(self, project_id, file_name, **kwargs): # noqa: E501
|
|
4369
|
-
"""
|
|
4370
|
-
|
|
4371
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
4406
|
+
"""Get a signed URL to download a named child file.
|
|
4372
4407
|
|
|
4373
4408
|
:param str project_id: 24-character hex ID (required)
|
|
4374
4409
|
:param str file_name: output file name (required)
|
|
@@ -4412,9 +4447,9 @@ class Flywheel:
|
|
|
4412
4447
|
|
|
4413
4448
|
|
|
4414
4449
|
def get_project_analysis_input_zip_info(self, project_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
4415
|
-
"""
|
|
4450
|
+
"""Retrieve the zip info of a child file by name.
|
|
4416
4451
|
|
|
4417
|
-
|
|
4452
|
+
Does not work on files whose names contain a forward slash.
|
|
4418
4453
|
|
|
4419
4454
|
:param str project_id: 24-character hex ID (required)
|
|
4420
4455
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -4432,9 +4467,7 @@ class Flywheel:
|
|
|
4432
4467
|
|
|
4433
4468
|
|
|
4434
4469
|
def get_project_analysis_input_download_url(self, project_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
4435
|
-
"""
|
|
4436
|
-
|
|
4437
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
4470
|
+
"""Get a signed URL to download a named child file.
|
|
4438
4471
|
|
|
4439
4472
|
:param str project_id: 24-character hex ID (required)
|
|
4440
4473
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -4477,9 +4510,9 @@ class Flywheel:
|
|
|
4477
4510
|
|
|
4478
4511
|
|
|
4479
4512
|
def get_project_analysis_output_zip_info(self, project_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
4480
|
-
"""
|
|
4513
|
+
"""Retrieve the zip info of a child file by name.
|
|
4481
4514
|
|
|
4482
|
-
|
|
4515
|
+
Does not work on files whose names contain a forward slash.
|
|
4483
4516
|
|
|
4484
4517
|
:param str project_id: 24-character hex ID (required)
|
|
4485
4518
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -4497,9 +4530,7 @@ class Flywheel:
|
|
|
4497
4530
|
|
|
4498
4531
|
|
|
4499
4532
|
def get_project_analysis_output_download_url(self, project_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
4500
|
-
"""
|
|
4501
|
-
|
|
4502
|
-
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
4533
|
+
"""Get a signed URL to download a named child file.
|
|
4503
4534
|
|
|
4504
4535
|
:param str project_id: 24-character hex ID (required)
|
|
4505
4536
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -4524,7 +4555,6 @@ class Flywheel:
|
|
|
4524
4555
|
def end_project_packfile_upload(self, token, metadata, file_count, project_id, **kwargs): # noqa: E501
|
|
4525
4556
|
"""End a packfile upload
|
|
4526
4557
|
|
|
4527
|
-
|
|
4528
4558
|
:param str token: (required)
|
|
4529
4559
|
:param str metadata: Metadata object as a JSON-encoded string (required)
|
|
4530
4560
|
:param int file_count: Number of files uploaded into this packfile. (required)
|
|
@@ -4538,7 +4568,6 @@ class Flywheel:
|
|
|
4538
4568
|
def get_all_projects(self, **kwargs): # noqa: E501
|
|
4539
4569
|
"""Get a list of projects
|
|
4540
4570
|
|
|
4541
|
-
|
|
4542
4571
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
4543
4572
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
4544
4573
|
:param int limit: The maximum number of entries to return.
|
|
@@ -4550,6 +4579,7 @@ class Flywheel:
|
|
|
4550
4579
|
:param bool join_avatars: Return the joined avatars of the permissions
|
|
4551
4580
|
:param JoinType join:
|
|
4552
4581
|
:param bool exhaustive: Set to return a complete list regardless of permissions
|
|
4582
|
+
:param bool include_all_info: Include all info in returned objects
|
|
4553
4583
|
:param list[union[HeaderFeature,str]] x_accept_feature:
|
|
4554
4584
|
:param bool async_: Perform the request asynchronously
|
|
4555
4585
|
:return: union[list[ProjectListOutput],Page]
|
|
@@ -4560,7 +4590,6 @@ class Flywheel:
|
|
|
4560
4590
|
def get_all_projects_groups(self, **kwargs): # noqa: E501
|
|
4561
4591
|
"""List all groups which have a project in them
|
|
4562
4592
|
|
|
4563
|
-
|
|
4564
4593
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
4565
4594
|
:param str sort: The sort fields and order.(e.g. label:asc,created:desc)
|
|
4566
4595
|
:param int limit: The maximum number of entries to return
|
|
@@ -4578,7 +4607,6 @@ class Flywheel:
|
|
|
4578
4607
|
def get_catalog_list_filter_options(self, **kwargs): # noqa: E501
|
|
4579
4608
|
"""Get all filter options for sharing a project
|
|
4580
4609
|
|
|
4581
|
-
|
|
4582
4610
|
:param bool async_: Perform the request asynchronously
|
|
4583
4611
|
:return: SharingFilterOptions
|
|
4584
4612
|
"""
|
|
@@ -4588,7 +4616,6 @@ class Flywheel:
|
|
|
4588
4616
|
def get_project(self, project_id, **kwargs): # noqa: E501
|
|
4589
4617
|
"""Get a single project
|
|
4590
4618
|
|
|
4591
|
-
|
|
4592
4619
|
:param str project_id: (required)
|
|
4593
4620
|
:param JoinType join:
|
|
4594
4621
|
:param bool join_avatars: add name and avatar to notes
|
|
@@ -4602,7 +4629,6 @@ class Flywheel:
|
|
|
4602
4629
|
def get_project_acquisitions(self, project_id, **kwargs): # noqa: E501
|
|
4603
4630
|
"""List all acquisitions for the given project.
|
|
4604
4631
|
|
|
4605
|
-
|
|
4606
4632
|
:param str project_id: (required)
|
|
4607
4633
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
4608
4634
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
@@ -4613,6 +4639,7 @@ class Flywheel:
|
|
|
4613
4639
|
:param str collection_id:
|
|
4614
4640
|
:param bool exhaustive:
|
|
4615
4641
|
:param JoinType join:
|
|
4642
|
+
:param bool include_all_info: Include all info in returned objects
|
|
4616
4643
|
:param list[str] x_accept_feature:
|
|
4617
4644
|
:param bool async_: Perform the request asynchronously
|
|
4618
4645
|
:return: union[list[AcquisitionListOutput],Page]
|
|
@@ -4635,6 +4662,7 @@ class Flywheel:
|
|
|
4635
4662
|
:param bool inflate_job:
|
|
4636
4663
|
:param bool join_avatars:
|
|
4637
4664
|
:param JoinType join:
|
|
4665
|
+
:param bool include_all_info: Include all info in returned objects
|
|
4638
4666
|
:param list[str] x_accept_feature:
|
|
4639
4667
|
:param bool async_: Perform the request asynchronously
|
|
4640
4668
|
:return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
@@ -4700,7 +4728,6 @@ class Flywheel:
|
|
|
4700
4728
|
def get_project_rules(self, project_id, **kwargs): # noqa: E501
|
|
4701
4729
|
"""List all rules for a project.
|
|
4702
4730
|
|
|
4703
|
-
|
|
4704
4731
|
:param str project_id: (required)
|
|
4705
4732
|
:param bool async_: Perform the request asynchronously
|
|
4706
4733
|
:return: list[GearRuleOutput]
|
|
@@ -4715,6 +4742,7 @@ class Flywheel:
|
|
|
4715
4742
|
|
|
4716
4743
|
:param str project_id: 24-char hex subject id (required)
|
|
4717
4744
|
:param JoinType join: join file origins
|
|
4745
|
+
:param bool include_all_info: Include all info in returned objects
|
|
4718
4746
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
4719
4747
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
4720
4748
|
:param int limit: The maximum number of entries to return.
|
|
@@ -4753,6 +4781,7 @@ class Flywheel:
|
|
|
4753
4781
|
:param int page: The page number (i.e. skip limit*page entries)
|
|
4754
4782
|
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
4755
4783
|
:param JoinType join:
|
|
4784
|
+
:param bool include_all_info: Include all info in returned objects
|
|
4756
4785
|
:param list[str] x_accept_feature:
|
|
4757
4786
|
:param bool async_: Perform the request asynchronously
|
|
4758
4787
|
:return: union[Page,list[SubjectOutputForList]]
|
|
@@ -4789,7 +4818,6 @@ class Flywheel:
|
|
|
4789
4818
|
def modify_project(self, project_id, body, **kwargs): # noqa: E501
|
|
4790
4819
|
"""Update a project
|
|
4791
4820
|
|
|
4792
|
-
|
|
4793
4821
|
:param str project_id: (required)
|
|
4794
4822
|
:param ProjectModify body: (required)
|
|
4795
4823
|
:param list[union[HeaderFeature,str]] x_accept_feature:
|
|
@@ -4858,7 +4886,7 @@ class Flywheel:
|
|
|
4858
4886
|
def modify_project_info(self, cid, body, **kwargs): # noqa: E501
|
|
4859
4887
|
"""Update or replace info for a(n) project.
|
|
4860
4888
|
|
|
4861
|
-
Update or replace info for a(n) project.
|
|
4889
|
+
Update or replace info for a(n) project. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
4862
4890
|
|
|
4863
4891
|
:param str cid: (required)
|
|
4864
4892
|
:param Info body: (required)
|
|
@@ -4941,7 +4969,6 @@ class Flywheel:
|
|
|
4941
4969
|
def project_packfile_upload(self, project_id, token, file, **kwargs): # noqa: E501
|
|
4942
4970
|
"""Add files to an in-progress packfile
|
|
4943
4971
|
|
|
4944
|
-
|
|
4945
4972
|
:param str project_id: (required)
|
|
4946
4973
|
:param str token: (required)
|
|
4947
4974
|
:param str file: (required)
|
|
@@ -4977,7 +5004,6 @@ class Flywheel:
|
|
|
4977
5004
|
def remove_project_rule(self, project_id, rule_id, **kwargs): # noqa: E501
|
|
4978
5005
|
"""Remove a project rule.
|
|
4979
5006
|
|
|
4980
|
-
|
|
4981
5007
|
:param str project_id: (required)
|
|
4982
5008
|
:param str rule_id: (required)
|
|
4983
5009
|
:param bool async_: Perform the request asynchronously
|
|
@@ -4989,7 +5015,6 @@ class Flywheel:
|
|
|
4989
5015
|
def remove_project_template(self, project_id, **kwargs): # noqa: E501
|
|
4990
5016
|
"""Remove the session template for a project.
|
|
4991
5017
|
|
|
4992
|
-
|
|
4993
5018
|
:param str project_id: (required)
|
|
4994
5019
|
:param bool async_: Perform the request asynchronously
|
|
4995
5020
|
:return: DeletedResult
|
|
@@ -5014,7 +5039,6 @@ class Flywheel:
|
|
|
5014
5039
|
def set_project_template(self, project_id, body, **kwargs): # noqa: E501
|
|
5015
5040
|
"""Set the session template for a project.
|
|
5016
5041
|
|
|
5017
|
-
|
|
5018
5042
|
:param str project_id: (required)
|
|
5019
5043
|
:param ProjectTemplateListInput body: (required)
|
|
5020
5044
|
:param bool async_: Perform the request asynchronously
|
|
@@ -5026,7 +5050,6 @@ class Flywheel:
|
|
|
5026
5050
|
def start_project_packfile_upload(self, project_id, **kwargs): # noqa: E501
|
|
5027
5051
|
"""Start a packfile upload to project
|
|
5028
5052
|
|
|
5029
|
-
|
|
5030
5053
|
:param str project_id: (required)
|
|
5031
5054
|
:param bool async_: Perform the request asynchronously
|
|
5032
5055
|
:return: UploadTokenOutput
|
|
@@ -5115,7 +5138,6 @@ class Flywheel:
|
|
|
5115
5138
|
def get_access_log_report(self, **kwargs): # noqa: E501
|
|
5116
5139
|
"""Get a report of access log entries for the given parameters
|
|
5117
5140
|
|
|
5118
|
-
|
|
5119
5141
|
:param bool csv: Set to download a csv file instead of json
|
|
5120
5142
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
5121
5143
|
:param str sort: The sort fields and order.(e.g. label:asc,created:desc)
|
|
@@ -5139,7 +5161,6 @@ class Flywheel:
|
|
|
5139
5161
|
def get_access_log_types(self, **kwargs): # noqa: E501
|
|
5140
5162
|
"""Get the list of types of access log entries
|
|
5141
5163
|
|
|
5142
|
-
|
|
5143
5164
|
:param bool async_: Perform the request asynchronously
|
|
5144
5165
|
:return: list[str]
|
|
5145
5166
|
"""
|
|
@@ -5192,7 +5213,6 @@ class Flywheel:
|
|
|
5192
5213
|
def get_site_report(self, **kwargs): # noqa: E501
|
|
5193
5214
|
"""Get the site report
|
|
5194
5215
|
|
|
5195
|
-
|
|
5196
5216
|
:param bool async_: Perform the request asynchronously
|
|
5197
5217
|
:return: SiteReport
|
|
5198
5218
|
"""
|
|
@@ -5256,7 +5276,6 @@ class Flywheel:
|
|
|
5256
5276
|
def add_role(self, body, **kwargs): # noqa: E501
|
|
5257
5277
|
"""Add a new role
|
|
5258
5278
|
|
|
5259
|
-
|
|
5260
5279
|
:param RoleInput body: (required)
|
|
5261
5280
|
:param bool async_: Perform the request asynchronously
|
|
5262
5281
|
:return: RoleOutput
|
|
@@ -5267,7 +5286,6 @@ class Flywheel:
|
|
|
5267
5286
|
def delete_role(self, role_id, **kwargs): # noqa: E501
|
|
5268
5287
|
"""Delete the role
|
|
5269
5288
|
|
|
5270
|
-
|
|
5271
5289
|
:param str role_id: The ID of the role (required)
|
|
5272
5290
|
:param bool async_: Perform the request asynchronously
|
|
5273
5291
|
:return: None
|
|
@@ -5278,7 +5296,6 @@ class Flywheel:
|
|
|
5278
5296
|
def get_all_roles(self, **kwargs): # noqa: E501
|
|
5279
5297
|
"""Get list of all roles
|
|
5280
5298
|
|
|
5281
|
-
|
|
5282
5299
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
5283
5300
|
:param str sort: The sort fields and order.(e.g. label:asc,created:desc)
|
|
5284
5301
|
:param int limit: The maximum number of entries to return
|
|
@@ -5295,7 +5312,6 @@ class Flywheel:
|
|
|
5295
5312
|
def get_role(self, role_id, **kwargs): # noqa: E501
|
|
5296
5313
|
"""Return the role identified by the RoleId
|
|
5297
5314
|
|
|
5298
|
-
|
|
5299
5315
|
:param str role_id: The ID of the role (required)
|
|
5300
5316
|
:param bool async_: Perform the request asynchronously
|
|
5301
5317
|
:return: RoleOutput
|
|
@@ -5306,7 +5322,6 @@ class Flywheel:
|
|
|
5306
5322
|
def modify_role(self, role_id, body, **kwargs): # noqa: E501
|
|
5307
5323
|
"""Update the role identified by RoleId
|
|
5308
5324
|
|
|
5309
|
-
|
|
5310
5325
|
:param str role_id: (required)
|
|
5311
5326
|
:param RoleUpdate body: (required)
|
|
5312
5327
|
:param list[union[HeaderFeature,str]] x_accept_feature:
|
|
@@ -5504,6 +5519,19 @@ class Flywheel:
|
|
|
5504
5519
|
return self.sessions_api.delete_sessions_by_ids(body, **kwargs)
|
|
5505
5520
|
|
|
5506
5521
|
|
|
5522
|
+
def delete_sessions_by_query(self, body, **kwargs): # noqa: E501
|
|
5523
|
+
"""Delete multiple sessions by query
|
|
5524
|
+
|
|
5525
|
+
Delete multiple sessions by query
|
|
5526
|
+
|
|
5527
|
+
:param list[Filter] body: Query for containers to delete (required)
|
|
5528
|
+
:param ContainerDeleteReason delete_reason:
|
|
5529
|
+
:param bool async_: Perform the request asynchronously
|
|
5530
|
+
:return: DeletedResult
|
|
5531
|
+
"""
|
|
5532
|
+
return self.sessions_api.delete_sessions_by_query(body, **kwargs)
|
|
5533
|
+
|
|
5534
|
+
|
|
5507
5535
|
def download_file_from_session(self, session_id, file_name, dest_file, **kwargs): # noqa: E501
|
|
5508
5536
|
"""Download a file.
|
|
5509
5537
|
|
|
@@ -5526,9 +5554,9 @@ class Flywheel:
|
|
|
5526
5554
|
|
|
5527
5555
|
|
|
5528
5556
|
def get_session_file_zip_info(self, session_id, file_name, **kwargs): # noqa: E501
|
|
5529
|
-
"""
|
|
5557
|
+
"""Retrieve the zip info of a child file by name.
|
|
5530
5558
|
|
|
5531
|
-
|
|
5559
|
+
Does not work on files whose names contain a forward slash.
|
|
5532
5560
|
|
|
5533
5561
|
:param str session_id: 24-character hex ID (required)
|
|
5534
5562
|
:param str file_name: output file name (required)
|
|
@@ -5547,9 +5575,7 @@ class Flywheel:
|
|
|
5547
5575
|
|
|
5548
5576
|
|
|
5549
5577
|
def get_session_download_url(self, session_id, file_name, **kwargs): # noqa: E501
|
|
5550
|
-
"""
|
|
5551
|
-
|
|
5552
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
5578
|
+
"""Get a signed URL to download a named child file.
|
|
5553
5579
|
|
|
5554
5580
|
:param str session_id: 24-character hex ID (required)
|
|
5555
5581
|
:param str file_name: output file name (required)
|
|
@@ -5593,9 +5619,9 @@ class Flywheel:
|
|
|
5593
5619
|
|
|
5594
5620
|
|
|
5595
5621
|
def get_session_analysis_input_zip_info(self, session_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
5596
|
-
"""
|
|
5622
|
+
"""Retrieve the zip info of a child file by name.
|
|
5597
5623
|
|
|
5598
|
-
|
|
5624
|
+
Does not work on files whose names contain a forward slash.
|
|
5599
5625
|
|
|
5600
5626
|
:param str session_id: 24-character hex ID (required)
|
|
5601
5627
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -5613,9 +5639,7 @@ class Flywheel:
|
|
|
5613
5639
|
|
|
5614
5640
|
|
|
5615
5641
|
def get_session_analysis_input_download_url(self, session_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
5616
|
-
"""
|
|
5617
|
-
|
|
5618
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
5642
|
+
"""Get a signed URL to download a named child file.
|
|
5619
5643
|
|
|
5620
5644
|
:param str session_id: 24-character hex ID (required)
|
|
5621
5645
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -5658,9 +5682,9 @@ class Flywheel:
|
|
|
5658
5682
|
|
|
5659
5683
|
|
|
5660
5684
|
def get_session_analysis_output_zip_info(self, session_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
5661
|
-
"""
|
|
5685
|
+
"""Retrieve the zip info of a child file by name.
|
|
5662
5686
|
|
|
5663
|
-
|
|
5687
|
+
Does not work on files whose names contain a forward slash.
|
|
5664
5688
|
|
|
5665
5689
|
:param str session_id: 24-character hex ID (required)
|
|
5666
5690
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -5678,9 +5702,7 @@ class Flywheel:
|
|
|
5678
5702
|
|
|
5679
5703
|
|
|
5680
5704
|
def get_session_analysis_output_download_url(self, session_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
5681
|
-
"""
|
|
5682
|
-
|
|
5683
|
-
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
5705
|
+
"""Get a signed URL to download a named child file.
|
|
5684
5706
|
|
|
5685
5707
|
:param str session_id: 24-character hex ID (required)
|
|
5686
5708
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -5710,6 +5732,7 @@ class Flywheel:
|
|
|
5710
5732
|
:param bool exhaustive: Set to return a complete list regardless of permissions
|
|
5711
5733
|
:param bool join_avatars: add name and avatar to notes
|
|
5712
5734
|
:param JoinType join: join file origins
|
|
5735
|
+
:param bool include_all_info: Include all info in returned objects
|
|
5713
5736
|
:param str user_id:
|
|
5714
5737
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
5715
5738
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
@@ -5748,6 +5771,7 @@ class Flywheel:
|
|
|
5748
5771
|
:param str collection_id:
|
|
5749
5772
|
:param bool exhaustive:
|
|
5750
5773
|
:param JoinType join:
|
|
5774
|
+
:param bool include_all_info: Include all info in returned objects
|
|
5751
5775
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
5752
5776
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
5753
5777
|
:param int limit: The maximum number of entries to return.
|
|
@@ -5776,6 +5800,7 @@ class Flywheel:
|
|
|
5776
5800
|
:param bool inflate_job:
|
|
5777
5801
|
:param bool join_avatars:
|
|
5778
5802
|
:param JoinType join:
|
|
5803
|
+
:param bool include_all_info: Include all info in returned objects
|
|
5779
5804
|
:param list[str] x_accept_feature:
|
|
5780
5805
|
:param bool async_: Perform the request asynchronously
|
|
5781
5806
|
:return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
@@ -5820,6 +5845,7 @@ class Flywheel:
|
|
|
5820
5845
|
:param str session_id: (required)
|
|
5821
5846
|
:param list[str] states: filter results by job state
|
|
5822
5847
|
:param list[str] tags: filter results by job tags
|
|
5848
|
+
:param bool include_all_info: Include all info in returned objects
|
|
5823
5849
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
5824
5850
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
5825
5851
|
:param int limit: The maximum number of entries to return.
|
|
@@ -5931,7 +5957,7 @@ class Flywheel:
|
|
|
5931
5957
|
def modify_session_info(self, cid, body, **kwargs): # noqa: E501
|
|
5932
5958
|
"""Update or replace info for a(n) session.
|
|
5933
5959
|
|
|
5934
|
-
Update or replace info for a(n) session.
|
|
5960
|
+
Update or replace info for a(n) session. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
5935
5961
|
|
|
5936
5962
|
:param str cid: (required)
|
|
5937
5963
|
:param Info body: (required)
|
|
@@ -6022,7 +6048,6 @@ class Flywheel:
|
|
|
6022
6048
|
def add_provider(self, body, **kwargs): # noqa: E501
|
|
6023
6049
|
"""Add a new provider
|
|
6024
6050
|
|
|
6025
|
-
|
|
6026
6051
|
:param IngressProvider body: (required)
|
|
6027
6052
|
:param bool async_: Perform the request asynchronously
|
|
6028
6053
|
:return: EgressProviderId
|
|
@@ -6033,7 +6058,6 @@ class Flywheel:
|
|
|
6033
6058
|
def add_site_rule(self, body, **kwargs): # noqa: E501
|
|
6034
6059
|
"""Create a new site rule.
|
|
6035
6060
|
|
|
6036
|
-
|
|
6037
6061
|
:param GearRuleInput body: (required)
|
|
6038
6062
|
:param bool async_: Perform the request asynchronously
|
|
6039
6063
|
:return: GearRule
|
|
@@ -6056,7 +6080,6 @@ class Flywheel:
|
|
|
6056
6080
|
def get_bookmark_list(self, **kwargs): # noqa: E501
|
|
6057
6081
|
"""Get Bookmark List
|
|
6058
6082
|
|
|
6059
|
-
|
|
6060
6083
|
:param bool async_: Perform the request asynchronously
|
|
6061
6084
|
:return: list[Bookmark]
|
|
6062
6085
|
"""
|
|
@@ -6108,7 +6131,6 @@ class Flywheel:
|
|
|
6108
6131
|
def get_site_rule(self, rule_id, **kwargs): # noqa: E501
|
|
6109
6132
|
"""Get a site rule.
|
|
6110
6133
|
|
|
6111
|
-
|
|
6112
6134
|
:param str rule_id: (required)
|
|
6113
6135
|
:param bool async_: Perform the request asynchronously
|
|
6114
6136
|
:return: GearRule
|
|
@@ -6119,7 +6141,6 @@ class Flywheel:
|
|
|
6119
6141
|
def get_site_rules(self, **kwargs): # noqa: E501
|
|
6120
6142
|
"""List all site rules.
|
|
6121
6143
|
|
|
6122
|
-
|
|
6123
6144
|
:param int limit:
|
|
6124
6145
|
:param str after_id:
|
|
6125
6146
|
:param str name:
|
|
@@ -6143,7 +6164,6 @@ class Flywheel:
|
|
|
6143
6164
|
def modify_bookmark_list(self, body, **kwargs): # noqa: E501
|
|
6144
6165
|
"""Modify Bookmark List
|
|
6145
6166
|
|
|
6146
|
-
|
|
6147
6167
|
:param list[Bookmark] body: (required)
|
|
6148
6168
|
:param bool async_: Perform the request asynchronously
|
|
6149
6169
|
:return: list[Bookmark]
|
|
@@ -6167,7 +6187,6 @@ class Flywheel:
|
|
|
6167
6187
|
def modify_site_rule(self, rule_id, body, **kwargs): # noqa: E501
|
|
6168
6188
|
"""Update a site rule.
|
|
6169
6189
|
|
|
6170
|
-
|
|
6171
6190
|
:param str rule_id: (required)
|
|
6172
6191
|
:param GearRuleModifyInput body: (required)
|
|
6173
6192
|
:param bool async_: Perform the request asynchronously
|
|
@@ -6179,7 +6198,6 @@ class Flywheel:
|
|
|
6179
6198
|
def modify_site_settings(self, body, **kwargs): # noqa: E501
|
|
6180
6199
|
"""Update administrative site settings
|
|
6181
6200
|
|
|
6182
|
-
|
|
6183
6201
|
:param IngressSiteSettings body: (required)
|
|
6184
6202
|
:param bool async_: Perform the request asynchronously
|
|
6185
6203
|
:return: SiteSettings
|
|
@@ -6190,7 +6208,6 @@ class Flywheel:
|
|
|
6190
6208
|
def remove_site_rule(self, rule_id, **kwargs): # noqa: E501
|
|
6191
6209
|
"""Remove a site rule.
|
|
6192
6210
|
|
|
6193
|
-
|
|
6194
6211
|
:param str rule_id: (required)
|
|
6195
6212
|
:param bool async_: Perform the request asynchronously
|
|
6196
6213
|
:return: None
|
|
@@ -6398,6 +6415,19 @@ class Flywheel:
|
|
|
6398
6415
|
return self.subjects_api.delete_subjects_by_ids(body, **kwargs)
|
|
6399
6416
|
|
|
6400
6417
|
|
|
6418
|
+
def delete_subjects_by_query(self, body, **kwargs): # noqa: E501
|
|
6419
|
+
"""Delete multiple subjects by query
|
|
6420
|
+
|
|
6421
|
+
Delete multiple subjects by query
|
|
6422
|
+
|
|
6423
|
+
:param list[Filter] body: Query for containers to delete (required)
|
|
6424
|
+
:param ContainerDeleteReason delete_reason:
|
|
6425
|
+
:param bool async_: Perform the request asynchronously
|
|
6426
|
+
:return: DeletedResult
|
|
6427
|
+
"""
|
|
6428
|
+
return self.subjects_api.delete_subjects_by_query(body, **kwargs)
|
|
6429
|
+
|
|
6430
|
+
|
|
6401
6431
|
def download_file_from_subject(self, subject_id, file_name, dest_file, **kwargs): # noqa: E501
|
|
6402
6432
|
"""Download a file.
|
|
6403
6433
|
|
|
@@ -6420,9 +6450,9 @@ class Flywheel:
|
|
|
6420
6450
|
|
|
6421
6451
|
|
|
6422
6452
|
def get_subject_file_zip_info(self, subject_id, file_name, **kwargs): # noqa: E501
|
|
6423
|
-
"""
|
|
6453
|
+
"""Retrieve the zip info of a child file by name.
|
|
6424
6454
|
|
|
6425
|
-
|
|
6455
|
+
Does not work on files whose names contain a forward slash.
|
|
6426
6456
|
|
|
6427
6457
|
:param str subject_id: 24-character hex ID (required)
|
|
6428
6458
|
:param str file_name: output file name (required)
|
|
@@ -6441,9 +6471,7 @@ class Flywheel:
|
|
|
6441
6471
|
|
|
6442
6472
|
|
|
6443
6473
|
def get_subject_download_url(self, subject_id, file_name, **kwargs): # noqa: E501
|
|
6444
|
-
"""
|
|
6445
|
-
|
|
6446
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
6474
|
+
"""Get a signed URL to download a named child file.
|
|
6447
6475
|
|
|
6448
6476
|
:param str subject_id: 24-character hex ID (required)
|
|
6449
6477
|
:param str file_name: output file name (required)
|
|
@@ -6487,9 +6515,9 @@ class Flywheel:
|
|
|
6487
6515
|
|
|
6488
6516
|
|
|
6489
6517
|
def get_subject_analysis_input_zip_info(self, subject_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
6490
|
-
"""
|
|
6518
|
+
"""Retrieve the zip info of a child file by name.
|
|
6491
6519
|
|
|
6492
|
-
|
|
6520
|
+
Does not work on files whose names contain a forward slash.
|
|
6493
6521
|
|
|
6494
6522
|
:param str subject_id: 24-character hex ID (required)
|
|
6495
6523
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -6507,9 +6535,7 @@ class Flywheel:
|
|
|
6507
6535
|
|
|
6508
6536
|
|
|
6509
6537
|
def get_subject_analysis_input_download_url(self, subject_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
6510
|
-
"""
|
|
6511
|
-
|
|
6512
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
6538
|
+
"""Get a signed URL to download a named child file.
|
|
6513
6539
|
|
|
6514
6540
|
:param str subject_id: 24-character hex ID (required)
|
|
6515
6541
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -6552,9 +6578,9 @@ class Flywheel:
|
|
|
6552
6578
|
|
|
6553
6579
|
|
|
6554
6580
|
def get_subject_analysis_output_zip_info(self, subject_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
6555
|
-
"""
|
|
6581
|
+
"""Retrieve the zip info of a child file by name.
|
|
6556
6582
|
|
|
6557
|
-
|
|
6583
|
+
Does not work on files whose names contain a forward slash.
|
|
6558
6584
|
|
|
6559
6585
|
:param str subject_id: 24-character hex ID (required)
|
|
6560
6586
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -6572,9 +6598,7 @@ class Flywheel:
|
|
|
6572
6598
|
|
|
6573
6599
|
|
|
6574
6600
|
def get_subject_analysis_output_download_url(self, subject_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
6575
|
-
"""
|
|
6576
|
-
|
|
6577
|
-
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
6601
|
+
"""Get a signed URL to download a named child file.
|
|
6578
6602
|
|
|
6579
6603
|
:param str subject_id: 24-character hex ID (required)
|
|
6580
6604
|
:param str analysis_id: 24-char hex analysis id (required)
|
|
@@ -6604,6 +6628,7 @@ class Flywheel:
|
|
|
6604
6628
|
:param bool exhaustive: Set to return a complete list regardless of permissions
|
|
6605
6629
|
:param JoinType join: join file origins
|
|
6606
6630
|
:param bool join_avatars: add name and avatar to notes
|
|
6631
|
+
:param bool include_all_info: Include all info in returned objects
|
|
6607
6632
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
6608
6633
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
6609
6634
|
:param int limit: The maximum number of entries to return.
|
|
@@ -6647,6 +6672,7 @@ class Flywheel:
|
|
|
6647
6672
|
:param bool inflate_job:
|
|
6648
6673
|
:param bool join_avatars:
|
|
6649
6674
|
:param JoinType join:
|
|
6675
|
+
:param bool include_all_info: Include all info in returned objects
|
|
6650
6676
|
:param list[str] x_accept_feature:
|
|
6651
6677
|
:param bool async_: Perform the request asynchronously
|
|
6652
6678
|
:return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
@@ -6703,6 +6729,7 @@ class Flywheel:
|
|
|
6703
6729
|
|
|
6704
6730
|
:param str subject_id: 24-char hex subject id (required)
|
|
6705
6731
|
:param JoinType join: join file origins
|
|
6732
|
+
:param bool include_all_info: Include all info in returned objects
|
|
6706
6733
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
6707
6734
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
6708
6735
|
:param int limit: The maximum number of entries to return.
|
|
@@ -6801,7 +6828,7 @@ class Flywheel:
|
|
|
6801
6828
|
def modify_subject_info(self, cid, body, **kwargs): # noqa: E501
|
|
6802
6829
|
"""Update or replace info for a(n) subject.
|
|
6803
6830
|
|
|
6804
|
-
Update or replace info for a(n) subject.
|
|
6831
|
+
Update or replace info for a(n) subject. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
6805
6832
|
|
|
6806
6833
|
:param str cid: (required)
|
|
6807
6834
|
:param Info body: (required)
|
|
@@ -6908,6 +6935,7 @@ class Flywheel:
|
|
|
6908
6935
|
|
|
6909
6936
|
:param GraphFilter body: (required)
|
|
6910
6937
|
:param bool exhaustive:
|
|
6938
|
+
:param bool include_all_info: Include all info in returned objects
|
|
6911
6939
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
6912
6940
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
6913
6941
|
:param int limit: The maximum number of entries to return.
|
|
@@ -6947,7 +6975,6 @@ class Flywheel:
|
|
|
6947
6975
|
def cleanup_signed_upload_url(self, body, **kwargs): # noqa: E501
|
|
6948
6976
|
"""Cleanup unused file blob previously uploaded using signed URL
|
|
6949
6977
|
|
|
6950
|
-
|
|
6951
6978
|
:param SignedUrlCleanupInput body: (required)
|
|
6952
6979
|
:param bool async_: Perform the request asynchronously
|
|
6953
6980
|
:return: None
|
|
@@ -7077,7 +7104,6 @@ class Flywheel:
|
|
|
7077
7104
|
def delete_user_key(self, id_, **kwargs): # noqa: E501
|
|
7078
7105
|
"""Delete User Api Key
|
|
7079
7106
|
|
|
7080
|
-
|
|
7081
7107
|
:param str id_: (required)
|
|
7082
7108
|
:param bool async_: Perform the request asynchronously
|
|
7083
7109
|
:return: None
|
|
@@ -7196,6 +7222,7 @@ class Flywheel:
|
|
|
7196
7222
|
:param int page: The page number (i.e. skip limit*page entries)
|
|
7197
7223
|
:param bool exhaustive: Set to return a complete list regardless of permissions
|
|
7198
7224
|
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
7225
|
+
:param bool include_all_info: Include all info in returned objects
|
|
7199
7226
|
:param bool async_: Perform the request asynchronously
|
|
7200
7227
|
:return: list[AcquisitionListOutput]
|
|
7201
7228
|
"""
|
|
@@ -7218,7 +7245,6 @@ class Flywheel:
|
|
|
7218
7245
|
def get_user_collections(self, user_id, **kwargs): # noqa: E501
|
|
7219
7246
|
"""Get all collections that belong to the given user.
|
|
7220
7247
|
|
|
7221
|
-
|
|
7222
7248
|
:param str user_id: (required)
|
|
7223
7249
|
:param str filter:
|
|
7224
7250
|
:param str sort:
|
|
@@ -7236,7 +7262,6 @@ class Flywheel:
|
|
|
7236
7262
|
def get_user_groups(self, uid, **kwargs): # noqa: E501
|
|
7237
7263
|
"""List all groups the specified user is a member of
|
|
7238
7264
|
|
|
7239
|
-
|
|
7240
7265
|
:param str uid: (required)
|
|
7241
7266
|
:param bool exhaustive: Set to return a complete list regardless of permissions
|
|
7242
7267
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
@@ -7265,6 +7290,7 @@ class Flywheel:
|
|
|
7265
7290
|
:param int page: The page number (i.e. skip limit*page entries)
|
|
7266
7291
|
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
7267
7292
|
:param bool exhaustive: Set to return a complete list regardless of permissions
|
|
7293
|
+
:param bool include_all_info: Include all info in returned objects
|
|
7268
7294
|
:param bool async_: Perform the request asynchronously
|
|
7269
7295
|
:return: list[ProjectListOutput]
|
|
7270
7296
|
"""
|
|
@@ -7284,6 +7310,7 @@ class Flywheel:
|
|
|
7284
7310
|
:param int page:
|
|
7285
7311
|
:param str after_id:
|
|
7286
7312
|
:param bool exhaustive:
|
|
7313
|
+
:param bool include_all_info: Include all info in returned objects
|
|
7287
7314
|
:param bool async_: Perform the request asynchronously
|
|
7288
7315
|
:return: list[SessionListOutput]
|
|
7289
7316
|
"""
|
|
@@ -7319,7 +7346,6 @@ class Flywheel:
|
|
|
7319
7346
|
def sync_user(self, cid, body, **kwargs): # noqa: E501
|
|
7320
7347
|
"""Sync a center user to enterprise (Sync service use ONLY)
|
|
7321
7348
|
|
|
7322
|
-
|
|
7323
7349
|
:param str cid: (required)
|
|
7324
7350
|
:param SyncUserInput body: (required)
|
|
7325
7351
|
:param bool async_: Perform the request asynchronously
|
|
@@ -7331,7 +7357,6 @@ class Flywheel:
|
|
|
7331
7357
|
def data_view_columns(self, **kwargs): # noqa: E501
|
|
7332
7358
|
"""Return a list of all known column aliases for use in data views
|
|
7333
7359
|
|
|
7334
|
-
|
|
7335
7360
|
:param bool async_: Perform the request asynchronously
|
|
7336
7361
|
:return: list[DataViewColumnAlias]
|
|
7337
7362
|
"""
|
|
@@ -7353,7 +7378,6 @@ class Flywheel:
|
|
|
7353
7378
|
def evaluate_view(self, view_id, container_id, **kwargs): # noqa: E501
|
|
7354
7379
|
"""Execute a view, returning data in the preferred format.
|
|
7355
7380
|
|
|
7356
|
-
|
|
7357
7381
|
:param str view_id: The ID of the view (required)
|
|
7358
7382
|
:param str container_id: The target container for view execution (required)
|
|
7359
7383
|
:param str ticket: download ticket id
|
|
@@ -7372,7 +7396,6 @@ class Flywheel:
|
|
|
7372
7396
|
def evaluate_view_adhoc(self, container_id, body, **kwargs): # noqa: E501
|
|
7373
7397
|
"""Execute an ad-hoc view, returning data in the preferred format.
|
|
7374
7398
|
|
|
7375
|
-
|
|
7376
7399
|
:param str container_id: The target container for view execution (required)
|
|
7377
7400
|
:param ContainerPipelineInput body: (required)
|
|
7378
7401
|
:param str filename: download ticket filename
|
|
@@ -7391,7 +7414,6 @@ class Flywheel:
|
|
|
7391
7414
|
def get_view(self, view_id, **kwargs): # noqa: E501
|
|
7392
7415
|
"""Return the view identified by ViewId
|
|
7393
7416
|
|
|
7394
|
-
|
|
7395
7417
|
:param str view_id: The ID of the view (required)
|
|
7396
7418
|
:param bool async_: Perform the request asynchronously
|
|
7397
7419
|
:return: ViewOutput
|
|
@@ -7402,7 +7424,6 @@ class Flywheel:
|
|
|
7402
7424
|
def modify_view(self, view_id, body, **kwargs): # noqa: E501
|
|
7403
7425
|
"""Update the view identified by ViewId
|
|
7404
7426
|
|
|
7405
|
-
|
|
7406
7427
|
:param str view_id: The ID of the view (required)
|
|
7407
7428
|
:param ContainerModify body: (required)
|
|
7408
7429
|
:param bool async_: Perform the request asynchronously
|
|
@@ -7414,7 +7435,6 @@ class Flywheel:
|
|
|
7414
7435
|
def queue_adhoc(self, container_id, body, **kwargs): # noqa: E501
|
|
7415
7436
|
"""Execute an ad-hoc view, returning a reference to the created data view execution.
|
|
7416
7437
|
|
|
7417
|
-
|
|
7418
7438
|
:param str container_id: The target container for view execution (required)
|
|
7419
7439
|
:param ContainerPipelineInput body: (required)
|
|
7420
7440
|
:param str sort: The sort fields and order.(e.g. label:asc,created:desc)
|