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.
- compute_api_client/__init__.py +22 -19
- compute_api_client/api/__init__.py +5 -6
- compute_api_client/api/algorithms_api.py +1333 -553
- compute_api_client/api/backend_api.py +1501 -0
- compute_api_client/api/backend_types_api.py +684 -0
- compute_api_client/api/batch_jobs_api.py +1937 -0
- compute_api_client/api/commits_api.py +1068 -435
- compute_api_client/api/files_api.py +1075 -435
- compute_api_client/api/final_results_api.py +736 -338
- compute_api_client/api/jobs_api.py +1653 -0
- compute_api_client/api/languages_api.py +556 -217
- compute_api_client/api/members_api.py +1057 -435
- compute_api_client/api/metadata_api.py +736 -337
- compute_api_client/api/permissions_api.py +1055 -421
- compute_api_client/api/projects_api.py +1604 -676
- compute_api_client/api/reservations_api.py +1124 -427
- compute_api_client/api/results_api.py +738 -337
- compute_api_client/api/teams_api.py +567 -220
- compute_api_client/api/transactions_api.py +679 -218
- compute_api_client/api/users_api.py +1090 -435
- compute_api_client/api_client.py +346 -304
- compute_api_client/api_response.py +21 -0
- compute_api_client/configuration.py +54 -67
- compute_api_client/docs/Algorithm.md +20 -3
- compute_api_client/docs/AlgorithmIn.md +20 -3
- compute_api_client/docs/AlgorithmType.md +0 -1
- compute_api_client/docs/AlgorithmsApi.md +78 -77
- compute_api_client/docs/Backend.md +33 -0
- compute_api_client/docs/BackendApi.md +419 -0
- compute_api_client/docs/BackendPatch.md +29 -0
- compute_api_client/docs/{RunStatus.md → BackendStatus.md} +1 -2
- compute_api_client/docs/BackendType.md +36 -0
- compute_api_client/docs/{RuntimeTypesApi.md → BackendTypesApi.md} +58 -31
- compute_api_client/docs/BackendWithAuthentication.md +34 -0
- compute_api_client/docs/BatchJob.md +38 -0
- compute_api_client/docs/BatchJobIn.md +29 -0
- compute_api_client/docs/{RuntimeStatus.md → BatchJobStatus.md} +1 -2
- compute_api_client/docs/{BatchRunsApi.md → BatchJobsApi.md} +170 -147
- compute_api_client/docs/Commit.md +18 -1
- compute_api_client/docs/CommitIn.md +17 -0
- compute_api_client/docs/CommitsApi.md +62 -71
- compute_api_client/docs/CompileStage.md +0 -1
- compute_api_client/docs/Domain.md +0 -1
- compute_api_client/docs/File.md +21 -4
- compute_api_client/docs/FileIn.md +21 -4
- compute_api_client/docs/FilesApi.md +65 -71
- compute_api_client/docs/FinalResult.md +20 -3
- compute_api_client/docs/FinalResultIn.md +19 -2
- compute_api_client/docs/FinalResultsApi.md +44 -71
- compute_api_client/docs/HTTPNotFoundError.md +17 -0
- compute_api_client/docs/HTTPValidationError.md +18 -1
- compute_api_client/docs/Job.md +36 -0
- compute_api_client/docs/JobIn.md +31 -0
- compute_api_client/docs/JobPatch.md +28 -0
- compute_api_client/docs/{BatchRunStatus.md → JobStatus.md} +1 -2
- compute_api_client/docs/{RunsApi.md → JobsApi.md} +137 -122
- compute_api_client/docs/Language.md +17 -0
- compute_api_client/docs/LanguagesApi.md +30 -12
- compute_api_client/docs/LocationInner.md +17 -0
- compute_api_client/docs/Member.md +19 -2
- compute_api_client/docs/MemberIn.md +19 -2
- compute_api_client/docs/MembersApi.md +59 -24
- compute_api_client/docs/Metadata.md +20 -3
- compute_api_client/docs/MetadataApi.md +49 -33
- compute_api_client/docs/MetadataIn.md +19 -2
- compute_api_client/docs/Permission.md +17 -0
- compute_api_client/docs/PermissionGroup.md +17 -0
- compute_api_client/docs/PermissionsApi.md +68 -28
- compute_api_client/docs/Project.md +20 -3
- compute_api_client/docs/ProjectIn.md +18 -1
- compute_api_client/docs/ProjectPatch.md +19 -2
- compute_api_client/docs/ProjectsApi.md +84 -36
- compute_api_client/docs/Reservation.md +21 -4
- compute_api_client/docs/ReservationIn.md +19 -2
- compute_api_client/docs/ReservationsApi.md +66 -24
- compute_api_client/docs/Result.md +23 -6
- compute_api_client/docs/ResultIn.md +19 -2
- compute_api_client/docs/ResultsApi.md +42 -26
- compute_api_client/docs/Role.md +0 -1
- compute_api_client/docs/ShareType.md +0 -1
- compute_api_client/docs/Team.md +18 -1
- compute_api_client/docs/TeamsApi.md +37 -14
- compute_api_client/docs/Transaction.md +21 -4
- compute_api_client/docs/TransactionsApi.md +50 -14
- compute_api_client/docs/User.md +21 -4
- compute_api_client/docs/UserIn.md +17 -0
- compute_api_client/docs/UsersApi.md +62 -24
- compute_api_client/docs/ValidationError.md +18 -1
- compute_api_client/exceptions.py +19 -16
- compute_api_client/models/__init__.py +16 -14
- compute_api_client/models/algorithm.py +78 -237
- compute_api_client/models/algorithm_in.py +76 -204
- compute_api_client/models/algorithm_type.py +21 -87
- compute_api_client/models/backend.py +100 -0
- compute_api_client/models/backend_patch.py +90 -0
- compute_api_client/models/backend_status.py +47 -0
- compute_api_client/models/backend_type.py +105 -0
- compute_api_client/models/backend_with_authentication.py +102 -0
- compute_api_client/models/batch_job.py +129 -0
- compute_api_client/models/batch_job_in.py +89 -0
- compute_api_client/models/batch_job_status.py +48 -0
- compute_api_client/models/commit.py +72 -230
- compute_api_client/models/commit_in.py +67 -169
- compute_api_client/models/compile_stage.py +23 -89
- compute_api_client/models/domain.py +22 -88
- compute_api_client/models/file.py +74 -288
- compute_api_client/models/file_in.py +72 -254
- compute_api_client/models/final_result.py +68 -198
- compute_api_client/models/final_result_in.py +63 -137
- compute_api_client/models/http_not_found_error.py +60 -105
- compute_api_client/models/http_validation_error.py +69 -105
- compute_api_client/models/job.py +120 -0
- compute_api_client/models/job_in.py +99 -0
- compute_api_client/models/job_patch.py +88 -0
- compute_api_client/models/job_status.py +48 -0
- compute_api_client/models/language.py +67 -172
- compute_api_client/models/location_inner.py +125 -84
- compute_api_client/models/member.py +70 -236
- compute_api_client/models/member_in.py +68 -203
- compute_api_client/models/metadata.py +68 -198
- compute_api_client/models/metadata_in.py +68 -137
- compute_api_client/models/permission.py +67 -172
- compute_api_client/models/permission_group.py +65 -142
- compute_api_client/models/project.py +74 -256
- compute_api_client/models/project_in.py +69 -195
- compute_api_client/models/project_patch.py +89 -192
- compute_api_client/models/reservation.py +79 -290
- compute_api_client/models/reservation_in.py +68 -200
- compute_api_client/models/result.py +101 -359
- compute_api_client/models/result_in.py +95 -291
- compute_api_client/models/role.py +21 -87
- compute_api_client/models/share_type.py +22 -88
- compute_api_client/models/team.py +69 -198
- compute_api_client/models/transaction.py +93 -299
- compute_api_client/models/user.py +75 -276
- compute_api_client/models/user_in.py +73 -243
- compute_api_client/models/validation_error.py +73 -160
- compute_api_client/rest.py +55 -114
- {qi_compute_api_client-0.7.0.dist-info → qi_compute_api_client-0.17.0.dist-info}/METADATA +47 -40
- qi_compute_api_client-0.17.0.dist-info/RECORD +142 -0
- compute_api_client/api/batch_runs_api.py +0 -862
- compute_api_client/api/runs_api.py +0 -723
- compute_api_client/api/runtime_api.py +0 -449
- compute_api_client/api/runtime_types_api.py +0 -303
- compute_api_client/docs/BatchRun.md +0 -21
- compute_api_client/docs/BatchRunIn.md +0 -12
- compute_api_client/docs/Run.md +0 -19
- compute_api_client/docs/RunIn.md +0 -14
- compute_api_client/docs/Runtime.md +0 -16
- compute_api_client/docs/RuntimeApi.md +0 -229
- compute_api_client/docs/RuntimeType.md +0 -19
- compute_api_client/docs/RuntimeWithAuthentication.md +0 -17
- compute_api_client/models/batch_run.py +0 -423
- compute_api_client/models/batch_run_in.py +0 -171
- compute_api_client/models/batch_run_status.py +0 -114
- compute_api_client/models/run.py +0 -376
- compute_api_client/models/run_in.py +0 -233
- compute_api_client/models/run_status.py +0 -114
- compute_api_client/models/runtime.py +0 -290
- compute_api_client/models/runtime_status.py +0 -113
- compute_api_client/models/runtime_type.py +0 -357
- compute_api_client/models/runtime_with_authentication.py +0 -320
- qi_compute_api_client-0.7.0.dist-info/RECORD +0 -137
- {qi_compute_api_client-0.7.0.dist-info → qi_compute_api_client-0.17.0.dist-info}/LICENSE.md +0 -0
- {qi_compute_api_client-0.7.0.dist-info → qi_compute_api_client-0.17.0.dist-info}/WHEEL +0 -0
|
@@ -1,32 +1,35 @@
|
|
|
1
|
-
# compute_api_client.
|
|
1
|
+
# compute_api_client.JobsApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *http://localhost*
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**
|
|
8
|
-
[**
|
|
9
|
-
[**
|
|
10
|
-
[**
|
|
11
|
-
[**
|
|
7
|
+
[**create_job_jobs_post**](JobsApi.md#create_job_jobs_post) | **POST** /jobs | Create job
|
|
8
|
+
[**delete_job_jobs_id_delete**](JobsApi.md#delete_job_jobs_id_delete) | **DELETE** /jobs/{id} | Destroy job
|
|
9
|
+
[**read_job_jobs_id_get**](JobsApi.md#read_job_jobs_id_get) | **GET** /jobs/{id} | Retrieve job
|
|
10
|
+
[**read_jobs_jobs_get**](JobsApi.md#read_jobs_jobs_get) | **GET** /jobs | List jobs
|
|
11
|
+
[**update_job_status_jobs_id_patch**](JobsApi.md#update_job_status_jobs_id_patch) | **PATCH** /jobs/{id} | Update Job Status
|
|
12
12
|
|
|
13
13
|
|
|
14
|
-
# **
|
|
15
|
-
>
|
|
14
|
+
# **create_job_jobs_post**
|
|
15
|
+
> Job create_job_jobs_post(job_in)
|
|
16
16
|
|
|
17
|
-
Create
|
|
17
|
+
Create job
|
|
18
18
|
|
|
19
|
-
Create new
|
|
19
|
+
Create new job.
|
|
20
20
|
|
|
21
21
|
### Example
|
|
22
22
|
|
|
23
23
|
* Api Key Authentication (user):
|
|
24
24
|
```python
|
|
25
|
-
from __future__ import print_function
|
|
26
25
|
import time
|
|
26
|
+
import os
|
|
27
27
|
import compute_api_client
|
|
28
|
+
from compute_api_client.models.job import Job
|
|
29
|
+
from compute_api_client.models.job_in import JobIn
|
|
28
30
|
from compute_api_client.rest import ApiException
|
|
29
31
|
from pprint import pprint
|
|
32
|
+
|
|
30
33
|
# Defining the host is optional and defaults to http://localhost
|
|
31
34
|
# See configuration.py for a list of all supported configuration parameters.
|
|
32
35
|
configuration = compute_api_client.Configuration(
|
|
@@ -39,34 +42,37 @@ configuration = compute_api_client.Configuration(
|
|
|
39
42
|
# satisfies your auth use case.
|
|
40
43
|
|
|
41
44
|
# Configure API key authorization: user
|
|
42
|
-
configuration.api_key['user'] =
|
|
45
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
43
46
|
|
|
44
47
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
45
48
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
46
49
|
|
|
47
50
|
# Enter a context with an instance of the API client
|
|
48
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
51
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
49
52
|
# Create an instance of the API class
|
|
50
|
-
api_instance = compute_api_client.
|
|
51
|
-
|
|
53
|
+
api_instance = compute_api_client.JobsApi(api_client)
|
|
54
|
+
job_in = compute_api_client.JobIn() # JobIn |
|
|
52
55
|
|
|
53
56
|
try:
|
|
54
|
-
# Create
|
|
55
|
-
api_response = api_instance.
|
|
57
|
+
# Create job
|
|
58
|
+
api_response = await api_instance.create_job_jobs_post(job_in)
|
|
59
|
+
print("The response of JobsApi->create_job_jobs_post:\n")
|
|
56
60
|
pprint(api_response)
|
|
57
|
-
except
|
|
58
|
-
print("Exception when calling
|
|
61
|
+
except Exception as e:
|
|
62
|
+
print("Exception when calling JobsApi->create_job_jobs_post: %s\n" % e)
|
|
59
63
|
```
|
|
60
64
|
|
|
65
|
+
|
|
66
|
+
|
|
61
67
|
### Parameters
|
|
62
68
|
|
|
63
69
|
Name | Type | Description | Notes
|
|
64
70
|
------------- | ------------- | ------------- | -------------
|
|
65
|
-
**
|
|
71
|
+
**job_in** | [**JobIn**](JobIn.md)| |
|
|
66
72
|
|
|
67
73
|
### Return type
|
|
68
74
|
|
|
69
|
-
[**
|
|
75
|
+
[**Job**](Job.md)
|
|
70
76
|
|
|
71
77
|
### Authorization
|
|
72
78
|
|
|
@@ -85,22 +91,23 @@ Name | Type | Description | Notes
|
|
|
85
91
|
|
|
86
92
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
87
93
|
|
|
88
|
-
# **
|
|
89
|
-
>
|
|
94
|
+
# **delete_job_jobs_id_delete**
|
|
95
|
+
> delete_job_jobs_id_delete(id)
|
|
90
96
|
|
|
91
|
-
Destroy
|
|
97
|
+
Destroy job
|
|
92
98
|
|
|
93
|
-
Delete a
|
|
99
|
+
Delete a job.
|
|
94
100
|
|
|
95
101
|
### Example
|
|
96
102
|
|
|
97
103
|
* Api Key Authentication (user):
|
|
98
104
|
```python
|
|
99
|
-
from __future__ import print_function
|
|
100
105
|
import time
|
|
106
|
+
import os
|
|
101
107
|
import compute_api_client
|
|
102
108
|
from compute_api_client.rest import ApiException
|
|
103
109
|
from pprint import pprint
|
|
110
|
+
|
|
104
111
|
# Defining the host is optional and defaults to http://localhost
|
|
105
112
|
# See configuration.py for a list of all supported configuration parameters.
|
|
106
113
|
configuration = compute_api_client.Configuration(
|
|
@@ -113,24 +120,26 @@ configuration = compute_api_client.Configuration(
|
|
|
113
120
|
# satisfies your auth use case.
|
|
114
121
|
|
|
115
122
|
# Configure API key authorization: user
|
|
116
|
-
configuration.api_key['user'] =
|
|
123
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
117
124
|
|
|
118
125
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
119
126
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
120
127
|
|
|
121
128
|
# Enter a context with an instance of the API client
|
|
122
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
129
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
123
130
|
# Create an instance of the API class
|
|
124
|
-
api_instance = compute_api_client.
|
|
131
|
+
api_instance = compute_api_client.JobsApi(api_client)
|
|
125
132
|
id = 56 # int |
|
|
126
133
|
|
|
127
134
|
try:
|
|
128
|
-
# Destroy
|
|
129
|
-
api_instance.
|
|
130
|
-
except
|
|
131
|
-
print("Exception when calling
|
|
135
|
+
# Destroy job
|
|
136
|
+
await api_instance.delete_job_jobs_id_delete(id)
|
|
137
|
+
except Exception as e:
|
|
138
|
+
print("Exception when calling JobsApi->delete_job_jobs_id_delete: %s\n" % e)
|
|
132
139
|
```
|
|
133
140
|
|
|
141
|
+
|
|
142
|
+
|
|
134
143
|
### Parameters
|
|
135
144
|
|
|
136
145
|
Name | Type | Description | Notes
|
|
@@ -159,22 +168,24 @@ void (empty response body)
|
|
|
159
168
|
|
|
160
169
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
161
170
|
|
|
162
|
-
# **
|
|
163
|
-
>
|
|
171
|
+
# **read_job_jobs_id_get**
|
|
172
|
+
> Job read_job_jobs_id_get(id)
|
|
164
173
|
|
|
165
|
-
Retrieve
|
|
174
|
+
Retrieve job
|
|
166
175
|
|
|
167
|
-
Get
|
|
176
|
+
Get job by ID.
|
|
168
177
|
|
|
169
178
|
### Example
|
|
170
179
|
|
|
171
180
|
* Api Key Authentication (user):
|
|
172
181
|
```python
|
|
173
|
-
from __future__ import print_function
|
|
174
182
|
import time
|
|
183
|
+
import os
|
|
175
184
|
import compute_api_client
|
|
185
|
+
from compute_api_client.models.job import Job
|
|
176
186
|
from compute_api_client.rest import ApiException
|
|
177
187
|
from pprint import pprint
|
|
188
|
+
|
|
178
189
|
# Defining the host is optional and defaults to http://localhost
|
|
179
190
|
# See configuration.py for a list of all supported configuration parameters.
|
|
180
191
|
configuration = compute_api_client.Configuration(
|
|
@@ -187,25 +198,28 @@ configuration = compute_api_client.Configuration(
|
|
|
187
198
|
# satisfies your auth use case.
|
|
188
199
|
|
|
189
200
|
# Configure API key authorization: user
|
|
190
|
-
configuration.api_key['user'] =
|
|
201
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
191
202
|
|
|
192
203
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
193
204
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
194
205
|
|
|
195
206
|
# Enter a context with an instance of the API client
|
|
196
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
207
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
197
208
|
# Create an instance of the API class
|
|
198
|
-
api_instance = compute_api_client.
|
|
209
|
+
api_instance = compute_api_client.JobsApi(api_client)
|
|
199
210
|
id = 56 # int |
|
|
200
211
|
|
|
201
212
|
try:
|
|
202
|
-
# Retrieve
|
|
203
|
-
api_response = api_instance.
|
|
213
|
+
# Retrieve job
|
|
214
|
+
api_response = await api_instance.read_job_jobs_id_get(id)
|
|
215
|
+
print("The response of JobsApi->read_job_jobs_id_get:\n")
|
|
204
216
|
pprint(api_response)
|
|
205
|
-
except
|
|
206
|
-
print("Exception when calling
|
|
217
|
+
except Exception as e:
|
|
218
|
+
print("Exception when calling JobsApi->read_job_jobs_id_get: %s\n" % e)
|
|
207
219
|
```
|
|
208
220
|
|
|
221
|
+
|
|
222
|
+
|
|
209
223
|
### Parameters
|
|
210
224
|
|
|
211
225
|
Name | Type | Description | Notes
|
|
@@ -214,7 +228,7 @@ Name | Type | Description | Notes
|
|
|
214
228
|
|
|
215
229
|
### Return type
|
|
216
230
|
|
|
217
|
-
[**
|
|
231
|
+
[**Job**](Job.md)
|
|
218
232
|
|
|
219
233
|
### Authorization
|
|
220
234
|
|
|
@@ -234,22 +248,26 @@ Name | Type | Description | Notes
|
|
|
234
248
|
|
|
235
249
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
236
250
|
|
|
237
|
-
# **
|
|
238
|
-
>
|
|
251
|
+
# **read_jobs_jobs_get**
|
|
252
|
+
> List[Job] read_jobs_jobs_get(latest=latest, id=id, created_on=created_on, file_id=file_id, algorithm_type=algorithm_type, status=status, batch_job_id=batch_job_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, number_of_shots__isnull=number_of_shots__isnull, number_of_shots=number_of_shots)
|
|
239
253
|
|
|
240
|
-
List
|
|
254
|
+
List jobs
|
|
241
255
|
|
|
242
|
-
List
|
|
256
|
+
List jobs.
|
|
243
257
|
|
|
244
258
|
### Example
|
|
245
259
|
|
|
246
260
|
* Api Key Authentication (user):
|
|
247
261
|
```python
|
|
248
|
-
from __future__ import print_function
|
|
249
262
|
import time
|
|
263
|
+
import os
|
|
250
264
|
import compute_api_client
|
|
265
|
+
from compute_api_client.models.algorithm_type import AlgorithmType
|
|
266
|
+
from compute_api_client.models.job import Job
|
|
267
|
+
from compute_api_client.models.job_status import JobStatus
|
|
251
268
|
from compute_api_client.rest import ApiException
|
|
252
269
|
from pprint import pprint
|
|
270
|
+
|
|
253
271
|
# Defining the host is optional and defaults to http://localhost
|
|
254
272
|
# See configuration.py for a list of all supported configuration parameters.
|
|
255
273
|
configuration = compute_api_client.Configuration(
|
|
@@ -262,30 +280,61 @@ configuration = compute_api_client.Configuration(
|
|
|
262
280
|
# satisfies your auth use case.
|
|
263
281
|
|
|
264
282
|
# Configure API key authorization: user
|
|
265
|
-
configuration.api_key['user'] =
|
|
283
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
266
284
|
|
|
267
285
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
268
286
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
269
287
|
|
|
270
288
|
# Enter a context with an instance of the API client
|
|
271
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
289
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
272
290
|
# Create an instance of the API class
|
|
273
|
-
api_instance = compute_api_client.
|
|
274
|
-
|
|
291
|
+
api_instance = compute_api_client.JobsApi(api_client)
|
|
292
|
+
latest = True # bool | (optional)
|
|
293
|
+
id = 56 # int | (optional)
|
|
294
|
+
created_on = '2013-10-20T19:20:30+01:00' # datetime | (optional)
|
|
295
|
+
file_id = 56 # int | (optional)
|
|
296
|
+
algorithm_type = compute_api_client.AlgorithmType() # AlgorithmType | (optional)
|
|
297
|
+
status = compute_api_client.JobStatus() # JobStatus | (optional)
|
|
298
|
+
batch_job_id = 56 # int | (optional)
|
|
299
|
+
queued_at__isnull = True # bool | (optional)
|
|
300
|
+
queued_at = '2013-10-20T19:20:30+01:00' # datetime | (optional)
|
|
301
|
+
finished_at__isnull = True # bool | (optional)
|
|
302
|
+
finished_at = '2013-10-20T19:20:30+01:00' # datetime | (optional)
|
|
303
|
+
number_of_shots__isnull = True # bool | (optional)
|
|
304
|
+
number_of_shots = 56 # int | (optional)
|
|
305
|
+
|
|
275
306
|
try:
|
|
276
|
-
# List
|
|
277
|
-
api_response = api_instance.
|
|
307
|
+
# List jobs
|
|
308
|
+
api_response = await api_instance.read_jobs_jobs_get(latest=latest, id=id, created_on=created_on, file_id=file_id, algorithm_type=algorithm_type, status=status, batch_job_id=batch_job_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, number_of_shots__isnull=number_of_shots__isnull, number_of_shots=number_of_shots)
|
|
309
|
+
print("The response of JobsApi->read_jobs_jobs_get:\n")
|
|
278
310
|
pprint(api_response)
|
|
279
|
-
except
|
|
280
|
-
print("Exception when calling
|
|
311
|
+
except Exception as e:
|
|
312
|
+
print("Exception when calling JobsApi->read_jobs_jobs_get: %s\n" % e)
|
|
281
313
|
```
|
|
282
314
|
|
|
315
|
+
|
|
316
|
+
|
|
283
317
|
### Parameters
|
|
284
|
-
|
|
318
|
+
|
|
319
|
+
Name | Type | Description | Notes
|
|
320
|
+
------------- | ------------- | ------------- | -------------
|
|
321
|
+
**latest** | **bool**| | [optional]
|
|
322
|
+
**id** | **int**| | [optional]
|
|
323
|
+
**created_on** | **datetime**| | [optional]
|
|
324
|
+
**file_id** | **int**| | [optional]
|
|
325
|
+
**algorithm_type** | [**AlgorithmType**](.md)| | [optional]
|
|
326
|
+
**status** | [**JobStatus**](.md)| | [optional]
|
|
327
|
+
**batch_job_id** | **int**| | [optional]
|
|
328
|
+
**queued_at__isnull** | **bool**| | [optional]
|
|
329
|
+
**queued_at** | **datetime**| | [optional]
|
|
330
|
+
**finished_at__isnull** | **bool**| | [optional]
|
|
331
|
+
**finished_at** | **datetime**| | [optional]
|
|
332
|
+
**number_of_shots__isnull** | **bool**| | [optional]
|
|
333
|
+
**number_of_shots** | **int**| | [optional]
|
|
285
334
|
|
|
286
335
|
### Return type
|
|
287
336
|
|
|
288
|
-
[**
|
|
337
|
+
[**List[Job]**](Job.md)
|
|
289
338
|
|
|
290
339
|
### Authorization
|
|
291
340
|
|
|
@@ -300,25 +349,30 @@ This endpoint does not need any parameter.
|
|
|
300
349
|
| Status code | Description | Response headers |
|
|
301
350
|
|-------------|-------------|------------------|
|
|
302
351
|
**200** | Successful Response | - |
|
|
352
|
+
**422** | Validation Error | - |
|
|
303
353
|
|
|
304
354
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
305
355
|
|
|
306
|
-
# **
|
|
307
|
-
>
|
|
356
|
+
# **update_job_status_jobs_id_patch**
|
|
357
|
+
> Job update_job_status_jobs_id_patch(id, job_patch)
|
|
308
358
|
|
|
309
|
-
|
|
359
|
+
Update Job Status
|
|
310
360
|
|
|
311
|
-
|
|
361
|
+
Update status of a job.
|
|
312
362
|
|
|
313
363
|
### Example
|
|
314
364
|
|
|
315
|
-
* Api Key Authentication (
|
|
365
|
+
* Api Key Authentication (backend):
|
|
366
|
+
* Api Key Authentication (user):
|
|
316
367
|
```python
|
|
317
|
-
from __future__ import print_function
|
|
318
368
|
import time
|
|
369
|
+
import os
|
|
319
370
|
import compute_api_client
|
|
371
|
+
from compute_api_client.models.job import Job
|
|
372
|
+
from compute_api_client.models.job_patch import JobPatch
|
|
320
373
|
from compute_api_client.rest import ApiException
|
|
321
374
|
from pprint import pprint
|
|
375
|
+
|
|
322
376
|
# Defining the host is optional and defaults to http://localhost
|
|
323
377
|
# See configuration.py for a list of all supported configuration parameters.
|
|
324
378
|
configuration = compute_api_client.Configuration(
|
|
@@ -330,93 +384,54 @@ configuration = compute_api_client.Configuration(
|
|
|
330
384
|
# Examples for each auth method are provided below, use the example that
|
|
331
385
|
# satisfies your auth use case.
|
|
332
386
|
|
|
333
|
-
# Configure API key authorization:
|
|
334
|
-
configuration.api_key['
|
|
387
|
+
# Configure API key authorization: backend
|
|
388
|
+
configuration.api_key['backend'] = os.environ["API_KEY"]
|
|
335
389
|
|
|
336
390
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
337
|
-
# configuration.api_key_prefix['
|
|
391
|
+
# configuration.api_key_prefix['backend'] = 'Bearer'
|
|
338
392
|
|
|
339
393
|
# Configure API key authorization: user
|
|
340
|
-
configuration.api_key['user'] =
|
|
394
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
341
395
|
|
|
342
396
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
343
397
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
344
398
|
|
|
345
399
|
# Enter a context with an instance of the API client
|
|
346
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
400
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
347
401
|
# Create an instance of the API class
|
|
348
|
-
api_instance = compute_api_client.
|
|
402
|
+
api_instance = compute_api_client.JobsApi(api_client)
|
|
349
403
|
id = 56 # int |
|
|
404
|
+
job_patch = compute_api_client.JobPatch() # JobPatch |
|
|
350
405
|
|
|
351
406
|
try:
|
|
352
|
-
#
|
|
353
|
-
api_response = api_instance.
|
|
407
|
+
# Update Job Status
|
|
408
|
+
api_response = await api_instance.update_job_status_jobs_id_patch(id, job_patch)
|
|
409
|
+
print("The response of JobsApi->update_job_status_jobs_id_patch:\n")
|
|
354
410
|
pprint(api_response)
|
|
355
|
-
except
|
|
356
|
-
print("Exception when calling
|
|
411
|
+
except Exception as e:
|
|
412
|
+
print("Exception when calling JobsApi->update_job_status_jobs_id_patch: %s\n" % e)
|
|
357
413
|
```
|
|
358
414
|
|
|
359
|
-
* Api Key Authentication (user):
|
|
360
|
-
```python
|
|
361
|
-
from __future__ import print_function
|
|
362
|
-
import time
|
|
363
|
-
import compute_api_client
|
|
364
|
-
from compute_api_client.rest import ApiException
|
|
365
|
-
from pprint import pprint
|
|
366
|
-
# Defining the host is optional and defaults to http://localhost
|
|
367
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
368
|
-
configuration = compute_api_client.Configuration(
|
|
369
|
-
host = "http://localhost"
|
|
370
|
-
)
|
|
371
|
-
|
|
372
|
-
# The client must configure the authentication and authorization parameters
|
|
373
|
-
# in accordance with the API server security policy.
|
|
374
|
-
# Examples for each auth method are provided below, use the example that
|
|
375
|
-
# satisfies your auth use case.
|
|
376
|
-
|
|
377
|
-
# Configure API key authorization: runtime
|
|
378
|
-
configuration.api_key['runtime'] = 'YOUR_API_KEY'
|
|
379
|
-
|
|
380
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
381
|
-
# configuration.api_key_prefix['runtime'] = 'Bearer'
|
|
382
|
-
|
|
383
|
-
# Configure API key authorization: user
|
|
384
|
-
configuration.api_key['user'] = 'YOUR_API_KEY'
|
|
385
|
-
|
|
386
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
387
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
388
415
|
|
|
389
|
-
# Enter a context with an instance of the API client
|
|
390
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
391
|
-
# Create an instance of the API class
|
|
392
|
-
api_instance = compute_api_client.RunsApi(api_client)
|
|
393
|
-
id = 56 # int |
|
|
394
|
-
|
|
395
|
-
try:
|
|
396
|
-
# Start run
|
|
397
|
-
api_response = api_instance.start_run_runs_id_start_patch(id)
|
|
398
|
-
pprint(api_response)
|
|
399
|
-
except ApiException as e:
|
|
400
|
-
print("Exception when calling RunsApi->start_run_runs_id_start_patch: %s\n" % e)
|
|
401
|
-
```
|
|
402
416
|
|
|
403
417
|
### Parameters
|
|
404
418
|
|
|
405
419
|
Name | Type | Description | Notes
|
|
406
420
|
------------- | ------------- | ------------- | -------------
|
|
407
421
|
**id** | **int**| |
|
|
422
|
+
**job_patch** | [**JobPatch**](JobPatch.md)| |
|
|
408
423
|
|
|
409
424
|
### Return type
|
|
410
425
|
|
|
411
|
-
[**
|
|
426
|
+
[**Job**](Job.md)
|
|
412
427
|
|
|
413
428
|
### Authorization
|
|
414
429
|
|
|
415
|
-
[
|
|
430
|
+
[backend](../README.md#backend), [user](../README.md#user)
|
|
416
431
|
|
|
417
432
|
### HTTP request headers
|
|
418
433
|
|
|
419
|
-
- **Content-Type**:
|
|
434
|
+
- **Content-Type**: application/json
|
|
420
435
|
- **Accept**: application/json
|
|
421
436
|
|
|
422
437
|
### HTTP response details
|
|
@@ -8,6 +8,23 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **str** | |
|
|
9
9
|
**version** | **str** | |
|
|
10
10
|
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```python
|
|
14
|
+
from compute_api_client.models.language import Language
|
|
15
|
+
|
|
16
|
+
# TODO update the JSON string below
|
|
17
|
+
json = "{}"
|
|
18
|
+
# create an instance of Language from a JSON string
|
|
19
|
+
language_instance = Language.from_json(json)
|
|
20
|
+
# print the JSON string representation of the object
|
|
21
|
+
print Language.to_json()
|
|
22
|
+
|
|
23
|
+
# convert the object into a dict
|
|
24
|
+
language_dict = language_instance.to_dict()
|
|
25
|
+
# create an instance of Language from a dict
|
|
26
|
+
language_form_dict = language.from_dict(language_dict)
|
|
27
|
+
```
|
|
11
28
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
12
29
|
|
|
13
30
|
|
|
@@ -19,11 +19,13 @@ Get language by ID.
|
|
|
19
19
|
|
|
20
20
|
* Api Key Authentication (user):
|
|
21
21
|
```python
|
|
22
|
-
from __future__ import print_function
|
|
23
22
|
import time
|
|
23
|
+
import os
|
|
24
24
|
import compute_api_client
|
|
25
|
+
from compute_api_client.models.language import Language
|
|
25
26
|
from compute_api_client.rest import ApiException
|
|
26
27
|
from pprint import pprint
|
|
28
|
+
|
|
27
29
|
# Defining the host is optional and defaults to http://localhost
|
|
28
30
|
# See configuration.py for a list of all supported configuration parameters.
|
|
29
31
|
configuration = compute_api_client.Configuration(
|
|
@@ -36,25 +38,28 @@ configuration = compute_api_client.Configuration(
|
|
|
36
38
|
# satisfies your auth use case.
|
|
37
39
|
|
|
38
40
|
# Configure API key authorization: user
|
|
39
|
-
configuration.api_key['user'] =
|
|
41
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
40
42
|
|
|
41
43
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
42
44
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
43
45
|
|
|
44
46
|
# Enter a context with an instance of the API client
|
|
45
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
47
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
46
48
|
# Create an instance of the API class
|
|
47
49
|
api_instance = compute_api_client.LanguagesApi(api_client)
|
|
48
50
|
id = 56 # int |
|
|
49
51
|
|
|
50
52
|
try:
|
|
51
53
|
# Retrieve language
|
|
52
|
-
api_response = api_instance.read_language_languages_id_get(id)
|
|
54
|
+
api_response = await api_instance.read_language_languages_id_get(id)
|
|
55
|
+
print("The response of LanguagesApi->read_language_languages_id_get:\n")
|
|
53
56
|
pprint(api_response)
|
|
54
|
-
except
|
|
57
|
+
except Exception as e:
|
|
55
58
|
print("Exception when calling LanguagesApi->read_language_languages_id_get: %s\n" % e)
|
|
56
59
|
```
|
|
57
60
|
|
|
61
|
+
|
|
62
|
+
|
|
58
63
|
### Parameters
|
|
59
64
|
|
|
60
65
|
Name | Type | Description | Notes
|
|
@@ -84,7 +89,7 @@ Name | Type | Description | Notes
|
|
|
84
89
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
85
90
|
|
|
86
91
|
# **read_languages_languages_get**
|
|
87
|
-
>
|
|
92
|
+
> List[Language] read_languages_languages_get(q=q, latest=latest, id=id, name=name, version=version)
|
|
88
93
|
|
|
89
94
|
List languages
|
|
90
95
|
|
|
@@ -94,11 +99,13 @@ List languages.
|
|
|
94
99
|
|
|
95
100
|
* Api Key Authentication (user):
|
|
96
101
|
```python
|
|
97
|
-
from __future__ import print_function
|
|
98
102
|
import time
|
|
103
|
+
import os
|
|
99
104
|
import compute_api_client
|
|
105
|
+
from compute_api_client.models.language import Language
|
|
100
106
|
from compute_api_client.rest import ApiException
|
|
101
107
|
from pprint import pprint
|
|
108
|
+
|
|
102
109
|
# Defining the host is optional and defaults to http://localhost
|
|
103
110
|
# See configuration.py for a list of all supported configuration parameters.
|
|
104
111
|
configuration = compute_api_client.Configuration(
|
|
@@ -111,34 +118,45 @@ configuration = compute_api_client.Configuration(
|
|
|
111
118
|
# satisfies your auth use case.
|
|
112
119
|
|
|
113
120
|
# Configure API key authorization: user
|
|
114
|
-
configuration.api_key['user'] =
|
|
121
|
+
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
115
122
|
|
|
116
123
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
117
124
|
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
118
125
|
|
|
119
126
|
# Enter a context with an instance of the API client
|
|
120
|
-
with compute_api_client.ApiClient(configuration) as api_client:
|
|
127
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
121
128
|
# Create an instance of the API class
|
|
122
129
|
api_instance = compute_api_client.LanguagesApi(api_client)
|
|
123
130
|
q = 'q_example' # str | (optional)
|
|
131
|
+
latest = True # bool | (optional)
|
|
132
|
+
id = 56 # int | (optional)
|
|
133
|
+
name = 'name_example' # str | (optional)
|
|
134
|
+
version = 'version_example' # str | (optional)
|
|
124
135
|
|
|
125
136
|
try:
|
|
126
137
|
# List languages
|
|
127
|
-
api_response = api_instance.read_languages_languages_get(q=q)
|
|
138
|
+
api_response = await api_instance.read_languages_languages_get(q=q, latest=latest, id=id, name=name, version=version)
|
|
139
|
+
print("The response of LanguagesApi->read_languages_languages_get:\n")
|
|
128
140
|
pprint(api_response)
|
|
129
|
-
except
|
|
141
|
+
except Exception as e:
|
|
130
142
|
print("Exception when calling LanguagesApi->read_languages_languages_get: %s\n" % e)
|
|
131
143
|
```
|
|
132
144
|
|
|
145
|
+
|
|
146
|
+
|
|
133
147
|
### Parameters
|
|
134
148
|
|
|
135
149
|
Name | Type | Description | Notes
|
|
136
150
|
------------- | ------------- | ------------- | -------------
|
|
137
151
|
**q** | **str**| | [optional]
|
|
152
|
+
**latest** | **bool**| | [optional]
|
|
153
|
+
**id** | **int**| | [optional]
|
|
154
|
+
**name** | **str**| | [optional]
|
|
155
|
+
**version** | **str**| | [optional]
|
|
138
156
|
|
|
139
157
|
### Return type
|
|
140
158
|
|
|
141
|
-
[**
|
|
159
|
+
[**List[Language]**](Language.md)
|
|
142
160
|
|
|
143
161
|
### Authorization
|
|
144
162
|
|
|
@@ -5,6 +5,23 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```python
|
|
11
|
+
from compute_api_client.models.location_inner import LocationInner
|
|
12
|
+
|
|
13
|
+
# TODO update the JSON string below
|
|
14
|
+
json = "{}"
|
|
15
|
+
# create an instance of LocationInner from a JSON string
|
|
16
|
+
location_inner_instance = LocationInner.from_json(json)
|
|
17
|
+
# print the JSON string representation of the object
|
|
18
|
+
print LocationInner.to_json()
|
|
19
|
+
|
|
20
|
+
# convert the object into a dict
|
|
21
|
+
location_inner_dict = location_inner_instance.to_dict()
|
|
22
|
+
# create an instance of LocationInner from a dict
|
|
23
|
+
location_inner_form_dict = location_inner.from_dict(location_inner_dict)
|
|
24
|
+
```
|
|
8
25
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
9
26
|
|
|
10
27
|
|
|
@@ -5,11 +5,28 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**id** | **int** | |
|
|
8
|
-
**role** | [**Role**](Role.md) | MEMBER: member<br/>ADMIN: admin |
|
|
9
|
-
**is_active** | **bool** | | [optional] [default to False]
|
|
10
8
|
**team_id** | **int** | |
|
|
11
9
|
**user_id** | **int** | |
|
|
10
|
+
**role** | [**Role**](Role.md) | |
|
|
11
|
+
**is_active** | **bool** | |
|
|
12
12
|
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```python
|
|
16
|
+
from compute_api_client.models.member import Member
|
|
17
|
+
|
|
18
|
+
# TODO update the JSON string below
|
|
19
|
+
json = "{}"
|
|
20
|
+
# create an instance of Member from a JSON string
|
|
21
|
+
member_instance = Member.from_json(json)
|
|
22
|
+
# print the JSON string representation of the object
|
|
23
|
+
print Member.to_json()
|
|
24
|
+
|
|
25
|
+
# convert the object into a dict
|
|
26
|
+
member_dict = member_instance.to_dict()
|
|
27
|
+
# create an instance of Member from a dict
|
|
28
|
+
member_form_dict = member.from_dict(member_dict)
|
|
29
|
+
```
|
|
13
30
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
14
31
|
|
|
15
32
|
|