qi-compute-api-client 0.7.0__py3-none-any.whl → 0.17.0__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.

Potentially problematic release.


This version of qi-compute-api-client might be problematic. Click here for more details.

Files changed (165) hide show
  1. compute_api_client/__init__.py +22 -19
  2. compute_api_client/api/__init__.py +5 -6
  3. compute_api_client/api/algorithms_api.py +1333 -553
  4. compute_api_client/api/backend_api.py +1501 -0
  5. compute_api_client/api/backend_types_api.py +684 -0
  6. compute_api_client/api/batch_jobs_api.py +1937 -0
  7. compute_api_client/api/commits_api.py +1068 -435
  8. compute_api_client/api/files_api.py +1075 -435
  9. compute_api_client/api/final_results_api.py +736 -338
  10. compute_api_client/api/jobs_api.py +1653 -0
  11. compute_api_client/api/languages_api.py +556 -217
  12. compute_api_client/api/members_api.py +1057 -435
  13. compute_api_client/api/metadata_api.py +736 -337
  14. compute_api_client/api/permissions_api.py +1055 -421
  15. compute_api_client/api/projects_api.py +1604 -676
  16. compute_api_client/api/reservations_api.py +1124 -427
  17. compute_api_client/api/results_api.py +738 -337
  18. compute_api_client/api/teams_api.py +567 -220
  19. compute_api_client/api/transactions_api.py +679 -218
  20. compute_api_client/api/users_api.py +1090 -435
  21. compute_api_client/api_client.py +346 -304
  22. compute_api_client/api_response.py +21 -0
  23. compute_api_client/configuration.py +54 -67
  24. compute_api_client/docs/Algorithm.md +20 -3
  25. compute_api_client/docs/AlgorithmIn.md +20 -3
  26. compute_api_client/docs/AlgorithmType.md +0 -1
  27. compute_api_client/docs/AlgorithmsApi.md +78 -77
  28. compute_api_client/docs/Backend.md +33 -0
  29. compute_api_client/docs/BackendApi.md +419 -0
  30. compute_api_client/docs/BackendPatch.md +29 -0
  31. compute_api_client/docs/{RunStatus.md → BackendStatus.md} +1 -2
  32. compute_api_client/docs/BackendType.md +36 -0
  33. compute_api_client/docs/{RuntimeTypesApi.md → BackendTypesApi.md} +58 -31
  34. compute_api_client/docs/BackendWithAuthentication.md +34 -0
  35. compute_api_client/docs/BatchJob.md +38 -0
  36. compute_api_client/docs/BatchJobIn.md +29 -0
  37. compute_api_client/docs/{RuntimeStatus.md → BatchJobStatus.md} +1 -2
  38. compute_api_client/docs/{BatchRunsApi.md → BatchJobsApi.md} +170 -147
  39. compute_api_client/docs/Commit.md +18 -1
  40. compute_api_client/docs/CommitIn.md +17 -0
  41. compute_api_client/docs/CommitsApi.md +62 -71
  42. compute_api_client/docs/CompileStage.md +0 -1
  43. compute_api_client/docs/Domain.md +0 -1
  44. compute_api_client/docs/File.md +21 -4
  45. compute_api_client/docs/FileIn.md +21 -4
  46. compute_api_client/docs/FilesApi.md +65 -71
  47. compute_api_client/docs/FinalResult.md +20 -3
  48. compute_api_client/docs/FinalResultIn.md +19 -2
  49. compute_api_client/docs/FinalResultsApi.md +44 -71
  50. compute_api_client/docs/HTTPNotFoundError.md +17 -0
  51. compute_api_client/docs/HTTPValidationError.md +18 -1
  52. compute_api_client/docs/Job.md +36 -0
  53. compute_api_client/docs/JobIn.md +31 -0
  54. compute_api_client/docs/JobPatch.md +28 -0
  55. compute_api_client/docs/{BatchRunStatus.md → JobStatus.md} +1 -2
  56. compute_api_client/docs/{RunsApi.md → JobsApi.md} +137 -122
  57. compute_api_client/docs/Language.md +17 -0
  58. compute_api_client/docs/LanguagesApi.md +30 -12
  59. compute_api_client/docs/LocationInner.md +17 -0
  60. compute_api_client/docs/Member.md +19 -2
  61. compute_api_client/docs/MemberIn.md +19 -2
  62. compute_api_client/docs/MembersApi.md +59 -24
  63. compute_api_client/docs/Metadata.md +20 -3
  64. compute_api_client/docs/MetadataApi.md +49 -33
  65. compute_api_client/docs/MetadataIn.md +19 -2
  66. compute_api_client/docs/Permission.md +17 -0
  67. compute_api_client/docs/PermissionGroup.md +17 -0
  68. compute_api_client/docs/PermissionsApi.md +68 -28
  69. compute_api_client/docs/Project.md +20 -3
  70. compute_api_client/docs/ProjectIn.md +18 -1
  71. compute_api_client/docs/ProjectPatch.md +19 -2
  72. compute_api_client/docs/ProjectsApi.md +84 -36
  73. compute_api_client/docs/Reservation.md +21 -4
  74. compute_api_client/docs/ReservationIn.md +19 -2
  75. compute_api_client/docs/ReservationsApi.md +66 -24
  76. compute_api_client/docs/Result.md +23 -6
  77. compute_api_client/docs/ResultIn.md +19 -2
  78. compute_api_client/docs/ResultsApi.md +42 -26
  79. compute_api_client/docs/Role.md +0 -1
  80. compute_api_client/docs/ShareType.md +0 -1
  81. compute_api_client/docs/Team.md +18 -1
  82. compute_api_client/docs/TeamsApi.md +37 -14
  83. compute_api_client/docs/Transaction.md +21 -4
  84. compute_api_client/docs/TransactionsApi.md +50 -14
  85. compute_api_client/docs/User.md +21 -4
  86. compute_api_client/docs/UserIn.md +17 -0
  87. compute_api_client/docs/UsersApi.md +62 -24
  88. compute_api_client/docs/ValidationError.md +18 -1
  89. compute_api_client/exceptions.py +19 -16
  90. compute_api_client/models/__init__.py +16 -14
  91. compute_api_client/models/algorithm.py +78 -237
  92. compute_api_client/models/algorithm_in.py +76 -204
  93. compute_api_client/models/algorithm_type.py +21 -87
  94. compute_api_client/models/backend.py +100 -0
  95. compute_api_client/models/backend_patch.py +90 -0
  96. compute_api_client/models/backend_status.py +47 -0
  97. compute_api_client/models/backend_type.py +105 -0
  98. compute_api_client/models/backend_with_authentication.py +102 -0
  99. compute_api_client/models/batch_job.py +129 -0
  100. compute_api_client/models/batch_job_in.py +89 -0
  101. compute_api_client/models/batch_job_status.py +48 -0
  102. compute_api_client/models/commit.py +72 -230
  103. compute_api_client/models/commit_in.py +67 -169
  104. compute_api_client/models/compile_stage.py +23 -89
  105. compute_api_client/models/domain.py +22 -88
  106. compute_api_client/models/file.py +74 -288
  107. compute_api_client/models/file_in.py +72 -254
  108. compute_api_client/models/final_result.py +68 -198
  109. compute_api_client/models/final_result_in.py +63 -137
  110. compute_api_client/models/http_not_found_error.py +60 -105
  111. compute_api_client/models/http_validation_error.py +69 -105
  112. compute_api_client/models/job.py +120 -0
  113. compute_api_client/models/job_in.py +99 -0
  114. compute_api_client/models/job_patch.py +88 -0
  115. compute_api_client/models/job_status.py +48 -0
  116. compute_api_client/models/language.py +67 -172
  117. compute_api_client/models/location_inner.py +125 -84
  118. compute_api_client/models/member.py +70 -236
  119. compute_api_client/models/member_in.py +68 -203
  120. compute_api_client/models/metadata.py +68 -198
  121. compute_api_client/models/metadata_in.py +68 -137
  122. compute_api_client/models/permission.py +67 -172
  123. compute_api_client/models/permission_group.py +65 -142
  124. compute_api_client/models/project.py +74 -256
  125. compute_api_client/models/project_in.py +69 -195
  126. compute_api_client/models/project_patch.py +89 -192
  127. compute_api_client/models/reservation.py +79 -290
  128. compute_api_client/models/reservation_in.py +68 -200
  129. compute_api_client/models/result.py +101 -359
  130. compute_api_client/models/result_in.py +95 -291
  131. compute_api_client/models/role.py +21 -87
  132. compute_api_client/models/share_type.py +22 -88
  133. compute_api_client/models/team.py +69 -198
  134. compute_api_client/models/transaction.py +93 -299
  135. compute_api_client/models/user.py +75 -276
  136. compute_api_client/models/user_in.py +73 -243
  137. compute_api_client/models/validation_error.py +73 -160
  138. compute_api_client/rest.py +55 -114
  139. {qi_compute_api_client-0.7.0.dist-info → qi_compute_api_client-0.17.0.dist-info}/METADATA +47 -40
  140. qi_compute_api_client-0.17.0.dist-info/RECORD +142 -0
  141. compute_api_client/api/batch_runs_api.py +0 -862
  142. compute_api_client/api/runs_api.py +0 -723
  143. compute_api_client/api/runtime_api.py +0 -449
  144. compute_api_client/api/runtime_types_api.py +0 -303
  145. compute_api_client/docs/BatchRun.md +0 -21
  146. compute_api_client/docs/BatchRunIn.md +0 -12
  147. compute_api_client/docs/Run.md +0 -19
  148. compute_api_client/docs/RunIn.md +0 -14
  149. compute_api_client/docs/Runtime.md +0 -16
  150. compute_api_client/docs/RuntimeApi.md +0 -229
  151. compute_api_client/docs/RuntimeType.md +0 -19
  152. compute_api_client/docs/RuntimeWithAuthentication.md +0 -17
  153. compute_api_client/models/batch_run.py +0 -423
  154. compute_api_client/models/batch_run_in.py +0 -171
  155. compute_api_client/models/batch_run_status.py +0 -114
  156. compute_api_client/models/run.py +0 -376
  157. compute_api_client/models/run_in.py +0 -233
  158. compute_api_client/models/run_status.py +0 -114
  159. compute_api_client/models/runtime.py +0 -290
  160. compute_api_client/models/runtime_status.py +0 -113
  161. compute_api_client/models/runtime_type.py +0 -357
  162. compute_api_client/models/runtime_with_authentication.py +0 -320
  163. qi_compute_api_client-0.7.0.dist-info/RECORD +0 -137
  164. {qi_compute_api_client-0.7.0.dist-info → qi_compute_api_client-0.17.0.dist-info}/LICENSE.md +0 -0
  165. {qi_compute_api_client-0.7.0.dist-info → qi_compute_api_client-0.17.0.dist-info}/WHEEL +0 -0
@@ -1,862 +0,0 @@
1
- # coding: utf-8
2
-
3
- """
4
- Quantum Inspire 2
5
-
6
- No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
7
-
8
- The version of the OpenAPI document: 0.1.0
9
- Generated by: https://openapi-generator.tech
10
- """
11
-
12
-
13
- from __future__ import absolute_import
14
-
15
- import re # noqa: F401
16
-
17
- # python 2 and python 3 compatibility library
18
- import six
19
-
20
- from compute_api_client.api_client import ApiClient
21
- from compute_api_client.exceptions import ( # noqa: F401
22
- ApiTypeError,
23
- ApiValueError
24
- )
25
-
26
-
27
- class BatchRunsApi(object):
28
- """NOTE: This class is auto generated by OpenAPI Generator
29
- Ref: https://openapi-generator.tech
30
-
31
- Do not edit the class manually.
32
- """
33
-
34
- def __init__(self, api_client=None):
35
- if api_client is None:
36
- api_client = ApiClient()
37
- self.api_client = api_client
38
-
39
- def create_batch_run_batch_runs_post(self, batch_run_in, **kwargs): # noqa: E501
40
- """Create batch run # noqa: E501
41
-
42
- Create new batch run. # noqa: E501
43
- This method makes a synchronous HTTP request by default. To make an
44
- asynchronous HTTP request, please pass async_req=True
45
-
46
- >>> thread = api.create_batch_run_batch_runs_post(batch_run_in, async_req=True)
47
- >>> result = thread.get()
48
-
49
- :param batch_run_in: (required)
50
- :type batch_run_in: BatchRunIn
51
- :param async_req: Whether to execute the request asynchronously.
52
- :type async_req: bool, optional
53
- :param _preload_content: if False, the urllib3.HTTPResponse object will
54
- be returned without reading/decoding response
55
- data. Default is True.
56
- :type _preload_content: bool, optional
57
- :param _request_timeout: timeout setting for this request. If one
58
- number provided, it will be total request
59
- timeout. It can also be a pair (tuple) of
60
- (connection, read) timeouts.
61
- :return: Returns the result object.
62
- If the method is called asynchronously,
63
- returns the request thread.
64
- :rtype: BatchRun
65
- """
66
- kwargs['_return_http_data_only'] = True
67
- return self.create_batch_run_batch_runs_post_with_http_info(batch_run_in, **kwargs) # noqa: E501
68
-
69
- def create_batch_run_batch_runs_post_with_http_info(self, batch_run_in, **kwargs): # noqa: E501
70
- """Create batch run # noqa: E501
71
-
72
- Create new batch run. # noqa: E501
73
- This method makes a synchronous HTTP request by default. To make an
74
- asynchronous HTTP request, please pass async_req=True
75
-
76
- >>> thread = api.create_batch_run_batch_runs_post_with_http_info(batch_run_in, async_req=True)
77
- >>> result = thread.get()
78
-
79
- :param batch_run_in: (required)
80
- :type batch_run_in: BatchRunIn
81
- :param async_req: Whether to execute the request asynchronously.
82
- :type async_req: bool, optional
83
- :param _return_http_data_only: response data without head status code
84
- and headers
85
- :type _return_http_data_only: bool, optional
86
- :param _preload_content: if False, the urllib3.HTTPResponse object will
87
- be returned without reading/decoding response
88
- data. Default is True.
89
- :type _preload_content: bool, optional
90
- :param _request_timeout: timeout setting for this request. If one
91
- number provided, it will be total request
92
- timeout. It can also be a pair (tuple) of
93
- (connection, read) timeouts.
94
- :param _request_auth: set to override the auth_settings for an a single
95
- request; this effectively ignores the authentication
96
- in the spec for a single request.
97
- :type _request_auth: dict, optional
98
- :type _content_type: string, optional: force content-type for the request
99
- :return: Returns the result object.
100
- If the method is called asynchronously,
101
- returns the request thread.
102
- :rtype: tuple(BatchRun, status_code(int), headers(HTTPHeaderDict))
103
- """
104
-
105
- local_var_params = locals()
106
-
107
- all_params = [
108
- 'batch_run_in'
109
- ]
110
- all_params.extend(
111
- [
112
- 'async_req',
113
- '_return_http_data_only',
114
- '_preload_content',
115
- '_request_timeout',
116
- '_request_auth',
117
- '_content_type',
118
- '_headers'
119
- ]
120
- )
121
-
122
- for key, val in six.iteritems(local_var_params['kwargs']):
123
- if key not in all_params:
124
- raise ApiTypeError(
125
- "Got an unexpected keyword argument '%s'"
126
- " to method create_batch_run_batch_runs_post" % key
127
- )
128
- local_var_params[key] = val
129
- del local_var_params['kwargs']
130
- # verify the required parameter 'batch_run_in' is set
131
- if self.api_client.client_side_validation and local_var_params.get('batch_run_in') is None: # noqa: E501
132
- raise ApiValueError("Missing the required parameter `batch_run_in` when calling `create_batch_run_batch_runs_post`") # noqa: E501
133
-
134
- collection_formats = {}
135
-
136
- path_params = {}
137
-
138
- query_params = []
139
-
140
- header_params = dict(local_var_params.get('_headers', {}))
141
-
142
- form_params = []
143
- local_var_files = {}
144
-
145
- body_params = None
146
- if 'batch_run_in' in local_var_params:
147
- body_params = local_var_params['batch_run_in']
148
- # HTTP header `Accept`
149
- header_params['Accept'] = self.api_client.select_header_accept(
150
- ['application/json']) # noqa: E501
151
-
152
- # HTTP header `Content-Type`
153
- content_types_list = local_var_params.get('_content_type',
154
- self.api_client.select_header_content_type(
155
- ['application/json'],
156
- 'POST', body_params)) # noqa: E501
157
- if content_types_list:
158
- header_params['Content-Type'] = content_types_list
159
-
160
- # Authentication setting
161
- auth_settings = ['user'] # noqa: E501
162
-
163
- response_types_map = {
164
- 201: "BatchRun",
165
- 422: "HTTPValidationError",
166
- }
167
-
168
- return self.api_client.call_api(
169
- '/batch_runs', 'POST',
170
- path_params,
171
- query_params,
172
- header_params,
173
- body=body_params,
174
- post_params=form_params,
175
- files=local_var_files,
176
- response_types_map=response_types_map,
177
- auth_settings=auth_settings,
178
- async_req=local_var_params.get('async_req'),
179
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
180
- _preload_content=local_var_params.get('_preload_content', True),
181
- _request_timeout=local_var_params.get('_request_timeout'),
182
- collection_formats=collection_formats,
183
- _request_auth=local_var_params.get('_request_auth'))
184
-
185
- def enqueue_batch_run_batch_runs_id_enqueue_patch(self, id, **kwargs): # noqa: E501
186
- """Enqueue batch run for execution # noqa: E501
187
-
188
- Enqueue batch run for execution. # noqa: E501
189
- This method makes a synchronous HTTP request by default. To make an
190
- asynchronous HTTP request, please pass async_req=True
191
-
192
- >>> thread = api.enqueue_batch_run_batch_runs_id_enqueue_patch(id, async_req=True)
193
- >>> result = thread.get()
194
-
195
- :param id: (required)
196
- :type id: int
197
- :param async_req: Whether to execute the request asynchronously.
198
- :type async_req: bool, optional
199
- :param _preload_content: if False, the urllib3.HTTPResponse object will
200
- be returned without reading/decoding response
201
- data. Default is True.
202
- :type _preload_content: bool, optional
203
- :param _request_timeout: timeout setting for this request. If one
204
- number provided, it will be total request
205
- timeout. It can also be a pair (tuple) of
206
- (connection, read) timeouts.
207
- :return: Returns the result object.
208
- If the method is called asynchronously,
209
- returns the request thread.
210
- :rtype: BatchRun
211
- """
212
- kwargs['_return_http_data_only'] = True
213
- return self.enqueue_batch_run_batch_runs_id_enqueue_patch_with_http_info(id, **kwargs) # noqa: E501
214
-
215
- def enqueue_batch_run_batch_runs_id_enqueue_patch_with_http_info(self, id, **kwargs): # noqa: E501
216
- """Enqueue batch run for execution # noqa: E501
217
-
218
- Enqueue batch run for execution. # noqa: E501
219
- This method makes a synchronous HTTP request by default. To make an
220
- asynchronous HTTP request, please pass async_req=True
221
-
222
- >>> thread = api.enqueue_batch_run_batch_runs_id_enqueue_patch_with_http_info(id, async_req=True)
223
- >>> result = thread.get()
224
-
225
- :param id: (required)
226
- :type id: int
227
- :param async_req: Whether to execute the request asynchronously.
228
- :type async_req: bool, optional
229
- :param _return_http_data_only: response data without head status code
230
- and headers
231
- :type _return_http_data_only: bool, optional
232
- :param _preload_content: if False, the urllib3.HTTPResponse object will
233
- be returned without reading/decoding response
234
- data. Default is True.
235
- :type _preload_content: bool, optional
236
- :param _request_timeout: timeout setting for this request. If one
237
- number provided, it will be total request
238
- timeout. It can also be a pair (tuple) of
239
- (connection, read) timeouts.
240
- :param _request_auth: set to override the auth_settings for an a single
241
- request; this effectively ignores the authentication
242
- in the spec for a single request.
243
- :type _request_auth: dict, optional
244
- :type _content_type: string, optional: force content-type for the request
245
- :return: Returns the result object.
246
- If the method is called asynchronously,
247
- returns the request thread.
248
- :rtype: tuple(BatchRun, status_code(int), headers(HTTPHeaderDict))
249
- """
250
-
251
- local_var_params = locals()
252
-
253
- all_params = [
254
- 'id'
255
- ]
256
- all_params.extend(
257
- [
258
- 'async_req',
259
- '_return_http_data_only',
260
- '_preload_content',
261
- '_request_timeout',
262
- '_request_auth',
263
- '_content_type',
264
- '_headers'
265
- ]
266
- )
267
-
268
- for key, val in six.iteritems(local_var_params['kwargs']):
269
- if key not in all_params:
270
- raise ApiTypeError(
271
- "Got an unexpected keyword argument '%s'"
272
- " to method enqueue_batch_run_batch_runs_id_enqueue_patch" % key
273
- )
274
- local_var_params[key] = val
275
- del local_var_params['kwargs']
276
- # verify the required parameter 'id' is set
277
- if self.api_client.client_side_validation and local_var_params.get('id') is None: # noqa: E501
278
- raise ApiValueError("Missing the required parameter `id` when calling `enqueue_batch_run_batch_runs_id_enqueue_patch`") # noqa: E501
279
-
280
- collection_formats = {}
281
-
282
- path_params = {}
283
- if 'id' in local_var_params:
284
- path_params['id'] = local_var_params['id'] # noqa: E501
285
-
286
- query_params = []
287
-
288
- header_params = dict(local_var_params.get('_headers', {}))
289
-
290
- form_params = []
291
- local_var_files = {}
292
-
293
- body_params = None
294
- # HTTP header `Accept`
295
- header_params['Accept'] = self.api_client.select_header_accept(
296
- ['application/json']) # noqa: E501
297
-
298
- # Authentication setting
299
- auth_settings = ['user'] # noqa: E501
300
-
301
- response_types_map = {
302
- 200: "BatchRun",
303
- 404: "HTTPNotFoundError",
304
- 422: "HTTPValidationError",
305
- }
306
-
307
- return self.api_client.call_api(
308
- '/batch_runs/{id}/enqueue', 'PATCH',
309
- path_params,
310
- query_params,
311
- header_params,
312
- body=body_params,
313
- post_params=form_params,
314
- files=local_var_files,
315
- response_types_map=response_types_map,
316
- auth_settings=auth_settings,
317
- async_req=local_var_params.get('async_req'),
318
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
319
- _preload_content=local_var_params.get('_preload_content', True),
320
- _request_timeout=local_var_params.get('_request_timeout'),
321
- collection_formats=collection_formats,
322
- _request_auth=local_var_params.get('_request_auth'))
323
-
324
- def finish_batch_run_batch_runs_id_finish_patch(self, id, **kwargs): # noqa: E501
325
- """Finish batch run # noqa: E501
326
-
327
- Finish batch run. # noqa: E501
328
- This method makes a synchronous HTTP request by default. To make an
329
- asynchronous HTTP request, please pass async_req=True
330
-
331
- >>> thread = api.finish_batch_run_batch_runs_id_finish_patch(id, async_req=True)
332
- >>> result = thread.get()
333
-
334
- :param id: (required)
335
- :type id: int
336
- :param async_req: Whether to execute the request asynchronously.
337
- :type async_req: bool, optional
338
- :param _preload_content: if False, the urllib3.HTTPResponse object will
339
- be returned without reading/decoding response
340
- data. Default is True.
341
- :type _preload_content: bool, optional
342
- :param _request_timeout: timeout setting for this request. If one
343
- number provided, it will be total request
344
- timeout. It can also be a pair (tuple) of
345
- (connection, read) timeouts.
346
- :return: Returns the result object.
347
- If the method is called asynchronously,
348
- returns the request thread.
349
- :rtype: BatchRun
350
- """
351
- kwargs['_return_http_data_only'] = True
352
- return self.finish_batch_run_batch_runs_id_finish_patch_with_http_info(id, **kwargs) # noqa: E501
353
-
354
- def finish_batch_run_batch_runs_id_finish_patch_with_http_info(self, id, **kwargs): # noqa: E501
355
- """Finish batch run # noqa: E501
356
-
357
- Finish batch run. # noqa: E501
358
- This method makes a synchronous HTTP request by default. To make an
359
- asynchronous HTTP request, please pass async_req=True
360
-
361
- >>> thread = api.finish_batch_run_batch_runs_id_finish_patch_with_http_info(id, async_req=True)
362
- >>> result = thread.get()
363
-
364
- :param id: (required)
365
- :type id: int
366
- :param async_req: Whether to execute the request asynchronously.
367
- :type async_req: bool, optional
368
- :param _return_http_data_only: response data without head status code
369
- and headers
370
- :type _return_http_data_only: bool, optional
371
- :param _preload_content: if False, the urllib3.HTTPResponse object will
372
- be returned without reading/decoding response
373
- data. Default is True.
374
- :type _preload_content: bool, optional
375
- :param _request_timeout: timeout setting for this request. If one
376
- number provided, it will be total request
377
- timeout. It can also be a pair (tuple) of
378
- (connection, read) timeouts.
379
- :param _request_auth: set to override the auth_settings for an a single
380
- request; this effectively ignores the authentication
381
- in the spec for a single request.
382
- :type _request_auth: dict, optional
383
- :type _content_type: string, optional: force content-type for the request
384
- :return: Returns the result object.
385
- If the method is called asynchronously,
386
- returns the request thread.
387
- :rtype: tuple(BatchRun, status_code(int), headers(HTTPHeaderDict))
388
- """
389
-
390
- local_var_params = locals()
391
-
392
- all_params = [
393
- 'id'
394
- ]
395
- all_params.extend(
396
- [
397
- 'async_req',
398
- '_return_http_data_only',
399
- '_preload_content',
400
- '_request_timeout',
401
- '_request_auth',
402
- '_content_type',
403
- '_headers'
404
- ]
405
- )
406
-
407
- for key, val in six.iteritems(local_var_params['kwargs']):
408
- if key not in all_params:
409
- raise ApiTypeError(
410
- "Got an unexpected keyword argument '%s'"
411
- " to method finish_batch_run_batch_runs_id_finish_patch" % key
412
- )
413
- local_var_params[key] = val
414
- del local_var_params['kwargs']
415
- # verify the required parameter 'id' is set
416
- if self.api_client.client_side_validation and local_var_params.get('id') is None: # noqa: E501
417
- raise ApiValueError("Missing the required parameter `id` when calling `finish_batch_run_batch_runs_id_finish_patch`") # noqa: E501
418
-
419
- collection_formats = {}
420
-
421
- path_params = {}
422
- if 'id' in local_var_params:
423
- path_params['id'] = local_var_params['id'] # noqa: E501
424
-
425
- query_params = []
426
-
427
- header_params = dict(local_var_params.get('_headers', {}))
428
-
429
- form_params = []
430
- local_var_files = {}
431
-
432
- body_params = None
433
- # HTTP header `Accept`
434
- header_params['Accept'] = self.api_client.select_header_accept(
435
- ['application/json']) # noqa: E501
436
-
437
- # Authentication setting
438
- auth_settings = ['runtime', 'user'] # noqa: E501
439
-
440
- response_types_map = {
441
- 200: "BatchRun",
442
- 404: "HTTPNotFoundError",
443
- 422: "HTTPValidationError",
444
- }
445
-
446
- return self.api_client.call_api(
447
- '/batch_runs/{id}/finish', 'PATCH',
448
- path_params,
449
- query_params,
450
- header_params,
451
- body=body_params,
452
- post_params=form_params,
453
- files=local_var_files,
454
- response_types_map=response_types_map,
455
- auth_settings=auth_settings,
456
- async_req=local_var_params.get('async_req'),
457
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
458
- _preload_content=local_var_params.get('_preload_content', True),
459
- _request_timeout=local_var_params.get('_request_timeout'),
460
- collection_formats=collection_formats,
461
- _request_auth=local_var_params.get('_request_auth'))
462
-
463
- def peek_batch_run_batch_runs_peek_patch(self, request_body, **kwargs): # noqa: E501
464
- """Peek batch run # noqa: E501
465
-
466
- Get batch run that can be taken up, excluding list of IDs. # noqa: E501
467
- This method makes a synchronous HTTP request by default. To make an
468
- asynchronous HTTP request, please pass async_req=True
469
-
470
- >>> thread = api.peek_batch_run_batch_runs_peek_patch(request_body, async_req=True)
471
- >>> result = thread.get()
472
-
473
- :param request_body: (required)
474
- :type request_body: list[int]
475
- :param async_req: Whether to execute the request asynchronously.
476
- :type async_req: bool, optional
477
- :param _preload_content: if False, the urllib3.HTTPResponse object will
478
- be returned without reading/decoding response
479
- data. Default is True.
480
- :type _preload_content: bool, optional
481
- :param _request_timeout: timeout setting for this request. If one
482
- number provided, it will be total request
483
- timeout. It can also be a pair (tuple) of
484
- (connection, read) timeouts.
485
- :return: Returns the result object.
486
- If the method is called asynchronously,
487
- returns the request thread.
488
- :rtype: BatchRun
489
- """
490
- kwargs['_return_http_data_only'] = True
491
- return self.peek_batch_run_batch_runs_peek_patch_with_http_info(request_body, **kwargs) # noqa: E501
492
-
493
- def peek_batch_run_batch_runs_peek_patch_with_http_info(self, request_body, **kwargs): # noqa: E501
494
- """Peek batch run # noqa: E501
495
-
496
- Get batch run that can be taken up, excluding list of IDs. # noqa: E501
497
- This method makes a synchronous HTTP request by default. To make an
498
- asynchronous HTTP request, please pass async_req=True
499
-
500
- >>> thread = api.peek_batch_run_batch_runs_peek_patch_with_http_info(request_body, async_req=True)
501
- >>> result = thread.get()
502
-
503
- :param request_body: (required)
504
- :type request_body: list[int]
505
- :param async_req: Whether to execute the request asynchronously.
506
- :type async_req: bool, optional
507
- :param _return_http_data_only: response data without head status code
508
- and headers
509
- :type _return_http_data_only: bool, optional
510
- :param _preload_content: if False, the urllib3.HTTPResponse object will
511
- be returned without reading/decoding response
512
- data. Default is True.
513
- :type _preload_content: bool, optional
514
- :param _request_timeout: timeout setting for this request. If one
515
- number provided, it will be total request
516
- timeout. It can also be a pair (tuple) of
517
- (connection, read) timeouts.
518
- :param _request_auth: set to override the auth_settings for an a single
519
- request; this effectively ignores the authentication
520
- in the spec for a single request.
521
- :type _request_auth: dict, optional
522
- :type _content_type: string, optional: force content-type for the request
523
- :return: Returns the result object.
524
- If the method is called asynchronously,
525
- returns the request thread.
526
- :rtype: tuple(BatchRun, status_code(int), headers(HTTPHeaderDict))
527
- """
528
-
529
- local_var_params = locals()
530
-
531
- all_params = [
532
- 'request_body'
533
- ]
534
- all_params.extend(
535
- [
536
- 'async_req',
537
- '_return_http_data_only',
538
- '_preload_content',
539
- '_request_timeout',
540
- '_request_auth',
541
- '_content_type',
542
- '_headers'
543
- ]
544
- )
545
-
546
- for key, val in six.iteritems(local_var_params['kwargs']):
547
- if key not in all_params:
548
- raise ApiTypeError(
549
- "Got an unexpected keyword argument '%s'"
550
- " to method peek_batch_run_batch_runs_peek_patch" % key
551
- )
552
- local_var_params[key] = val
553
- del local_var_params['kwargs']
554
- # verify the required parameter 'request_body' is set
555
- if self.api_client.client_side_validation and local_var_params.get('request_body') is None: # noqa: E501
556
- raise ApiValueError("Missing the required parameter `request_body` when calling `peek_batch_run_batch_runs_peek_patch`") # noqa: E501
557
-
558
- collection_formats = {}
559
-
560
- path_params = {}
561
-
562
- query_params = []
563
-
564
- header_params = dict(local_var_params.get('_headers', {}))
565
-
566
- form_params = []
567
- local_var_files = {}
568
-
569
- body_params = None
570
- if 'request_body' in local_var_params:
571
- body_params = local_var_params['request_body']
572
- # HTTP header `Accept`
573
- header_params['Accept'] = self.api_client.select_header_accept(
574
- ['application/json']) # noqa: E501
575
-
576
- # HTTP header `Content-Type`
577
- content_types_list = local_var_params.get('_content_type',
578
- self.api_client.select_header_content_type(
579
- ['application/json'],
580
- 'PATCH', body_params)) # noqa: E501
581
- if content_types_list:
582
- header_params['Content-Type'] = content_types_list
583
-
584
- # Authentication setting
585
- auth_settings = ['runtime'] # noqa: E501
586
-
587
- response_types_map = {
588
- 200: "BatchRun",
589
- 422: "HTTPValidationError",
590
- }
591
-
592
- return self.api_client.call_api(
593
- '/batch_runs/peek', 'PATCH',
594
- path_params,
595
- query_params,
596
- header_params,
597
- body=body_params,
598
- post_params=form_params,
599
- files=local_var_files,
600
- response_types_map=response_types_map,
601
- auth_settings=auth_settings,
602
- async_req=local_var_params.get('async_req'),
603
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
604
- _preload_content=local_var_params.get('_preload_content', True),
605
- _request_timeout=local_var_params.get('_request_timeout'),
606
- collection_formats=collection_formats,
607
- _request_auth=local_var_params.get('_request_auth'))
608
-
609
- def pop_batch_run_batch_runs_pop_patch(self, **kwargs): # noqa: E501
610
- """Take batch run # noqa: E501
611
-
612
- Claim batch run by ID. # noqa: E501
613
- This method makes a synchronous HTTP request by default. To make an
614
- asynchronous HTTP request, please pass async_req=True
615
-
616
- >>> thread = api.pop_batch_run_batch_runs_pop_patch(async_req=True)
617
- >>> result = thread.get()
618
-
619
- :param async_req: Whether to execute the request asynchronously.
620
- :type async_req: bool, optional
621
- :param _preload_content: if False, the urllib3.HTTPResponse object will
622
- be returned without reading/decoding response
623
- data. Default is True.
624
- :type _preload_content: bool, optional
625
- :param _request_timeout: timeout setting for this request. If one
626
- number provided, it will be total request
627
- timeout. It can also be a pair (tuple) of
628
- (connection, read) timeouts.
629
- :return: Returns the result object.
630
- If the method is called asynchronously,
631
- returns the request thread.
632
- :rtype: BatchRun
633
- """
634
- kwargs['_return_http_data_only'] = True
635
- return self.pop_batch_run_batch_runs_pop_patch_with_http_info(**kwargs) # noqa: E501
636
-
637
- def pop_batch_run_batch_runs_pop_patch_with_http_info(self, **kwargs): # noqa: E501
638
- """Take batch run # noqa: E501
639
-
640
- Claim batch run by ID. # noqa: E501
641
- This method makes a synchronous HTTP request by default. To make an
642
- asynchronous HTTP request, please pass async_req=True
643
-
644
- >>> thread = api.pop_batch_run_batch_runs_pop_patch_with_http_info(async_req=True)
645
- >>> result = thread.get()
646
-
647
- :param async_req: Whether to execute the request asynchronously.
648
- :type async_req: bool, optional
649
- :param _return_http_data_only: response data without head status code
650
- and headers
651
- :type _return_http_data_only: bool, optional
652
- :param _preload_content: if False, the urllib3.HTTPResponse object will
653
- be returned without reading/decoding response
654
- data. Default is True.
655
- :type _preload_content: bool, optional
656
- :param _request_timeout: timeout setting for this request. If one
657
- number provided, it will be total request
658
- timeout. It can also be a pair (tuple) of
659
- (connection, read) timeouts.
660
- :param _request_auth: set to override the auth_settings for an a single
661
- request; this effectively ignores the authentication
662
- in the spec for a single request.
663
- :type _request_auth: dict, optional
664
- :type _content_type: string, optional: force content-type for the request
665
- :return: Returns the result object.
666
- If the method is called asynchronously,
667
- returns the request thread.
668
- :rtype: tuple(BatchRun, status_code(int), headers(HTTPHeaderDict))
669
- """
670
-
671
- local_var_params = locals()
672
-
673
- all_params = [
674
- ]
675
- all_params.extend(
676
- [
677
- 'async_req',
678
- '_return_http_data_only',
679
- '_preload_content',
680
- '_request_timeout',
681
- '_request_auth',
682
- '_content_type',
683
- '_headers'
684
- ]
685
- )
686
-
687
- for key, val in six.iteritems(local_var_params['kwargs']):
688
- if key not in all_params:
689
- raise ApiTypeError(
690
- "Got an unexpected keyword argument '%s'"
691
- " to method pop_batch_run_batch_runs_pop_patch" % key
692
- )
693
- local_var_params[key] = val
694
- del local_var_params['kwargs']
695
-
696
- collection_formats = {}
697
-
698
- path_params = {}
699
-
700
- query_params = []
701
-
702
- header_params = dict(local_var_params.get('_headers', {}))
703
-
704
- form_params = []
705
- local_var_files = {}
706
-
707
- body_params = None
708
- # HTTP header `Accept`
709
- header_params['Accept'] = self.api_client.select_header_accept(
710
- ['application/json']) # noqa: E501
711
-
712
- # Authentication setting
713
- auth_settings = ['runtime'] # noqa: E501
714
-
715
- response_types_map = {
716
- 200: "BatchRun",
717
- 404: "HTTPNotFoundError",
718
- }
719
-
720
- return self.api_client.call_api(
721
- '/batch_runs/pop', 'PATCH',
722
- path_params,
723
- query_params,
724
- header_params,
725
- body=body_params,
726
- post_params=form_params,
727
- files=local_var_files,
728
- response_types_map=response_types_map,
729
- auth_settings=auth_settings,
730
- async_req=local_var_params.get('async_req'),
731
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
732
- _preload_content=local_var_params.get('_preload_content', True),
733
- _request_timeout=local_var_params.get('_request_timeout'),
734
- collection_formats=collection_formats,
735
- _request_auth=local_var_params.get('_request_auth'))
736
-
737
- def read_batch_runs_batch_runs_get(self, **kwargs): # noqa: E501
738
- """List batch runs # noqa: E501
739
-
740
- List batch runs. # noqa: E501
741
- This method makes a synchronous HTTP request by default. To make an
742
- asynchronous HTTP request, please pass async_req=True
743
-
744
- >>> thread = api.read_batch_runs_batch_runs_get(async_req=True)
745
- >>> result = thread.get()
746
-
747
- :param async_req: Whether to execute the request asynchronously.
748
- :type async_req: bool, optional
749
- :param _preload_content: if False, the urllib3.HTTPResponse object will
750
- be returned without reading/decoding response
751
- data. Default is True.
752
- :type _preload_content: bool, optional
753
- :param _request_timeout: timeout setting for this request. If one
754
- number provided, it will be total request
755
- timeout. It can also be a pair (tuple) of
756
- (connection, read) timeouts.
757
- :return: Returns the result object.
758
- If the method is called asynchronously,
759
- returns the request thread.
760
- :rtype: list[BatchRun]
761
- """
762
- kwargs['_return_http_data_only'] = True
763
- return self.read_batch_runs_batch_runs_get_with_http_info(**kwargs) # noqa: E501
764
-
765
- def read_batch_runs_batch_runs_get_with_http_info(self, **kwargs): # noqa: E501
766
- """List batch runs # noqa: E501
767
-
768
- List batch runs. # noqa: E501
769
- This method makes a synchronous HTTP request by default. To make an
770
- asynchronous HTTP request, please pass async_req=True
771
-
772
- >>> thread = api.read_batch_runs_batch_runs_get_with_http_info(async_req=True)
773
- >>> result = thread.get()
774
-
775
- :param async_req: Whether to execute the request asynchronously.
776
- :type async_req: bool, optional
777
- :param _return_http_data_only: response data without head status code
778
- and headers
779
- :type _return_http_data_only: bool, optional
780
- :param _preload_content: if False, the urllib3.HTTPResponse object will
781
- be returned without reading/decoding response
782
- data. Default is True.
783
- :type _preload_content: bool, optional
784
- :param _request_timeout: timeout setting for this request. If one
785
- number provided, it will be total request
786
- timeout. It can also be a pair (tuple) of
787
- (connection, read) timeouts.
788
- :param _request_auth: set to override the auth_settings for an a single
789
- request; this effectively ignores the authentication
790
- in the spec for a single request.
791
- :type _request_auth: dict, optional
792
- :type _content_type: string, optional: force content-type for the request
793
- :return: Returns the result object.
794
- If the method is called asynchronously,
795
- returns the request thread.
796
- :rtype: tuple(list[BatchRun], status_code(int), headers(HTTPHeaderDict))
797
- """
798
-
799
- local_var_params = locals()
800
-
801
- all_params = [
802
- ]
803
- all_params.extend(
804
- [
805
- 'async_req',
806
- '_return_http_data_only',
807
- '_preload_content',
808
- '_request_timeout',
809
- '_request_auth',
810
- '_content_type',
811
- '_headers'
812
- ]
813
- )
814
-
815
- for key, val in six.iteritems(local_var_params['kwargs']):
816
- if key not in all_params:
817
- raise ApiTypeError(
818
- "Got an unexpected keyword argument '%s'"
819
- " to method read_batch_runs_batch_runs_get" % key
820
- )
821
- local_var_params[key] = val
822
- del local_var_params['kwargs']
823
-
824
- collection_formats = {}
825
-
826
- path_params = {}
827
-
828
- query_params = []
829
-
830
- header_params = dict(local_var_params.get('_headers', {}))
831
-
832
- form_params = []
833
- local_var_files = {}
834
-
835
- body_params = None
836
- # HTTP header `Accept`
837
- header_params['Accept'] = self.api_client.select_header_accept(
838
- ['application/json']) # noqa: E501
839
-
840
- # Authentication setting
841
- auth_settings = ['user'] # noqa: E501
842
-
843
- response_types_map = {
844
- 200: "list[BatchRun]",
845
- }
846
-
847
- return self.api_client.call_api(
848
- '/batch_runs', 'GET',
849
- path_params,
850
- query_params,
851
- header_params,
852
- body=body_params,
853
- post_params=form_params,
854
- files=local_var_files,
855
- response_types_map=response_types_map,
856
- auth_settings=auth_settings,
857
- async_req=local_var_params.get('async_req'),
858
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
859
- _preload_content=local_var_params.get('_preload_content', True),
860
- _request_timeout=local_var_params.get('_request_timeout'),
861
- collection_formats=collection_formats,
862
- _request_auth=local_var_params.get('_request_auth'))