qi-compute-api-client 0.17.0__py3-none-any.whl → 0.27.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 +2 -1
- compute_api_client/api/algorithms_api.py +110 -1
- compute_api_client/api/backend_api.py +71 -16
- compute_api_client/api/backend_types_api.py +106 -1
- compute_api_client/api/batch_jobs_api.py +310 -5
- compute_api_client/api/commits_api.py +56 -1
- compute_api_client/api/files_api.py +56 -1
- compute_api_client/api/final_results_api.py +4 -1
- compute_api_client/api/jobs_api.py +60 -2
- compute_api_client/api/languages_api.py +54 -1
- compute_api_client/api/members_api.py +57 -2
- compute_api_client/api/metadata_api.py +3 -1
- compute_api_client/api/permissions_api.py +107 -1
- compute_api_client/api/projects_api.py +80 -4
- compute_api_client/api/reservations_api.py +57 -2
- compute_api_client/api/results_api.py +268 -7
- compute_api_client/api/teams_api.py +54 -1
- compute_api_client/api/transactions_api.py +55 -2
- compute_api_client/api/users_api.py +73 -1
- compute_api_client/api_client.py +1 -1
- compute_api_client/configuration.py +8 -1
- compute_api_client/docs/Algorithm.md +1 -0
- compute_api_client/docs/AlgorithmIn.md +1 -0
- compute_api_client/docs/AlgorithmsApi.md +34 -7
- compute_api_client/docs/BackendApi.md +25 -10
- compute_api_client/docs/BackendIn.md +32 -0
- compute_api_client/docs/BackendType.md +3 -0
- compute_api_client/docs/BackendTypesApi.md +23 -4
- compute_api_client/docs/BatchJobIn.md +0 -1
- compute_api_client/docs/BatchJobsApi.md +101 -7
- compute_api_client/docs/CommitIn.md +0 -1
- compute_api_client/docs/CommitsApi.md +24 -6
- compute_api_client/docs/FilesApi.md +24 -6
- compute_api_client/docs/FinalResultsApi.md +12 -3
- compute_api_client/docs/JobIn.md +0 -1
- compute_api_client/docs/JobsApi.md +42 -7
- compute_api_client/docs/LanguagesApi.md +16 -4
- compute_api_client/docs/MembersApi.md +24 -6
- compute_api_client/docs/MetadataApi.md +8 -2
- compute_api_client/docs/PermissionsApi.md +32 -8
- compute_api_client/docs/ProjectsApi.md +35 -9
- compute_api_client/docs/ReservationsApi.md +24 -6
- compute_api_client/docs/ResultsApi.md +90 -6
- compute_api_client/docs/TeamsApi.md +16 -4
- compute_api_client/docs/TransactionsApi.md +16 -4
- compute_api_client/docs/User.md +1 -0
- compute_api_client/docs/UserIn.md +1 -0
- compute_api_client/docs/UsersApi.md +26 -6
- compute_api_client/exceptions.py +1 -1
- compute_api_client/models/__init__.py +2 -1
- compute_api_client/models/algorithm.py +10 -3
- compute_api_client/models/algorithm_in.py +10 -3
- compute_api_client/models/algorithm_type.py +1 -1
- compute_api_client/models/backend.py +1 -1
- compute_api_client/models/backend_in.py +98 -0
- compute_api_client/models/backend_patch.py +1 -1
- compute_api_client/models/backend_status.py +1 -1
- compute_api_client/models/backend_type.py +10 -3
- compute_api_client/models/backend_with_authentication.py +1 -1
- compute_api_client/models/batch_job.py +1 -1
- compute_api_client/models/batch_job_in.py +2 -4
- compute_api_client/models/batch_job_status.py +1 -1
- compute_api_client/models/commit.py +1 -1
- compute_api_client/models/commit_in.py +2 -6
- compute_api_client/models/compile_stage.py +1 -1
- compute_api_client/models/domain.py +1 -1
- compute_api_client/models/file.py +1 -1
- compute_api_client/models/file_in.py +1 -1
- compute_api_client/models/final_result.py +1 -1
- compute_api_client/models/final_result_in.py +1 -1
- compute_api_client/models/http_not_found_error.py +1 -1
- compute_api_client/models/http_validation_error.py +1 -1
- compute_api_client/models/job.py +1 -1
- compute_api_client/models/job_in.py +2 -5
- compute_api_client/models/job_patch.py +1 -1
- compute_api_client/models/job_status.py +1 -1
- compute_api_client/models/language.py +1 -1
- compute_api_client/models/location_inner.py +1 -1
- compute_api_client/models/member.py +1 -1
- compute_api_client/models/member_in.py +1 -1
- compute_api_client/models/metadata.py +1 -1
- compute_api_client/models/metadata_in.py +1 -1
- compute_api_client/models/permission.py +1 -1
- compute_api_client/models/permission_group.py +1 -1
- compute_api_client/models/project.py +1 -1
- compute_api_client/models/project_in.py +1 -1
- compute_api_client/models/project_patch.py +1 -1
- compute_api_client/models/reservation.py +1 -1
- compute_api_client/models/reservation_in.py +1 -1
- compute_api_client/models/result.py +1 -1
- compute_api_client/models/result_in.py +1 -1
- compute_api_client/models/role.py +1 -1
- compute_api_client/models/share_type.py +1 -1
- compute_api_client/models/team.py +1 -1
- compute_api_client/models/transaction.py +1 -1
- compute_api_client/models/user.py +5 -3
- compute_api_client/models/user_in.py +5 -3
- compute_api_client/models/validation_error.py +1 -1
- compute_api_client/rest.py +1 -1
- {qi_compute_api_client-0.17.0.dist-info → qi_compute_api_client-0.27.0.dist-info}/METADATA +17 -5
- qi_compute_api_client-0.27.0.dist-info/RECORD +144 -0
- qi_compute_api_client-0.17.0.dist-info/RECORD +0 -142
- {qi_compute_api_client-0.17.0.dist-info → qi_compute_api_client-0.27.0.dist-info}/LICENSE.md +0 -0
- {qi_compute_api_client-0.17.0.dist-info → qi_compute_api_client-0.27.0.dist-info}/WHEEL +0 -0
|
@@ -12,7 +12,7 @@ Method | HTTP request | Description
|
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
# **create_backend_backends_post**
|
|
15
|
-
> BackendWithAuthentication create_backend_backends_post(
|
|
15
|
+
> BackendWithAuthentication create_backend_backends_post(backend_in)
|
|
16
16
|
|
|
17
17
|
Create backend
|
|
18
18
|
|
|
@@ -20,12 +20,13 @@ Create new backend.
|
|
|
20
20
|
|
|
21
21
|
### Example
|
|
22
22
|
|
|
23
|
+
* OAuth Authentication (user_bearer):
|
|
23
24
|
* Api Key Authentication (user):
|
|
24
25
|
```python
|
|
25
26
|
import time
|
|
26
27
|
import os
|
|
27
28
|
import compute_api_client
|
|
28
|
-
from compute_api_client.models.
|
|
29
|
+
from compute_api_client.models.backend_in import BackendIn
|
|
29
30
|
from compute_api_client.models.backend_with_authentication import BackendWithAuthentication
|
|
30
31
|
from compute_api_client.rest import ApiException
|
|
31
32
|
from pprint import pprint
|
|
@@ -41,6 +42,8 @@ configuration = compute_api_client.Configuration(
|
|
|
41
42
|
# Examples for each auth method are provided below, use the example that
|
|
42
43
|
# satisfies your auth use case.
|
|
43
44
|
|
|
45
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
46
|
+
|
|
44
47
|
# Configure API key authorization: user
|
|
45
48
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
46
49
|
|
|
@@ -51,11 +54,11 @@ configuration.api_key['user'] = os.environ["API_KEY"]
|
|
|
51
54
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
52
55
|
# Create an instance of the API class
|
|
53
56
|
api_instance = compute_api_client.BackendApi(api_client)
|
|
54
|
-
|
|
57
|
+
backend_in = compute_api_client.BackendIn() # BackendIn |
|
|
55
58
|
|
|
56
59
|
try:
|
|
57
60
|
# Create backend
|
|
58
|
-
api_response = await api_instance.create_backend_backends_post(
|
|
61
|
+
api_response = await api_instance.create_backend_backends_post(backend_in)
|
|
59
62
|
print("The response of BackendApi->create_backend_backends_post:\n")
|
|
60
63
|
pprint(api_response)
|
|
61
64
|
except Exception as e:
|
|
@@ -68,7 +71,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
68
71
|
|
|
69
72
|
Name | Type | Description | Notes
|
|
70
73
|
------------- | ------------- | ------------- | -------------
|
|
71
|
-
**
|
|
74
|
+
**backend_in** | [**BackendIn**](BackendIn.md)| |
|
|
72
75
|
|
|
73
76
|
### Return type
|
|
74
77
|
|
|
@@ -76,7 +79,7 @@ Name | Type | Description | Notes
|
|
|
76
79
|
|
|
77
80
|
### Authorization
|
|
78
81
|
|
|
79
|
-
[user](../README.md#user)
|
|
82
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
80
83
|
|
|
81
84
|
### HTTP request headers
|
|
82
85
|
|
|
@@ -100,6 +103,7 @@ Get backend by ID.
|
|
|
100
103
|
|
|
101
104
|
### Example
|
|
102
105
|
|
|
106
|
+
* OAuth Authentication (user_bearer):
|
|
103
107
|
* Api Key Authentication (user):
|
|
104
108
|
```python
|
|
105
109
|
import time
|
|
@@ -120,6 +124,8 @@ configuration = compute_api_client.Configuration(
|
|
|
120
124
|
# Examples for each auth method are provided below, use the example that
|
|
121
125
|
# satisfies your auth use case.
|
|
122
126
|
|
|
127
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
128
|
+
|
|
123
129
|
# Configure API key authorization: user
|
|
124
130
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
125
131
|
|
|
@@ -155,7 +161,7 @@ Name | Type | Description | Notes
|
|
|
155
161
|
|
|
156
162
|
### Authorization
|
|
157
163
|
|
|
158
|
-
[user](../README.md#user)
|
|
164
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
159
165
|
|
|
160
166
|
### HTTP request headers
|
|
161
167
|
|
|
@@ -246,7 +252,7 @@ This endpoint does not need any parameter.
|
|
|
246
252
|
[[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)
|
|
247
253
|
|
|
248
254
|
# **read_backends_backends_get**
|
|
249
|
-
> List[Backend] read_backends_backends_get(latest=latest, id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat)
|
|
255
|
+
> List[Backend] read_backends_backends_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat)
|
|
250
256
|
|
|
251
257
|
List backends
|
|
252
258
|
|
|
@@ -254,6 +260,7 @@ Read backends.
|
|
|
254
260
|
|
|
255
261
|
### Example
|
|
256
262
|
|
|
263
|
+
* OAuth Authentication (user_bearer):
|
|
257
264
|
* Api Key Authentication (user):
|
|
258
265
|
```python
|
|
259
266
|
import time
|
|
@@ -275,6 +282,8 @@ configuration = compute_api_client.Configuration(
|
|
|
275
282
|
# Examples for each auth method are provided below, use the example that
|
|
276
283
|
# satisfies your auth use case.
|
|
277
284
|
|
|
285
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
286
|
+
|
|
278
287
|
# Configure API key authorization: user
|
|
279
288
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
280
289
|
|
|
@@ -286,6 +295,9 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
286
295
|
# Create an instance of the API class
|
|
287
296
|
api_instance = compute_api_client.BackendApi(api_client)
|
|
288
297
|
latest = True # bool | (optional)
|
|
298
|
+
sort_by = 'sort_by_example' # str | (optional)
|
|
299
|
+
page_number = 56 # int | (optional)
|
|
300
|
+
items_per_page = 56 # int | (optional)
|
|
289
301
|
id = 56 # int | (optional)
|
|
290
302
|
name = 'name_example' # str | (optional)
|
|
291
303
|
location = 'location_example' # str | (optional)
|
|
@@ -295,7 +307,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
295
307
|
|
|
296
308
|
try:
|
|
297
309
|
# List backends
|
|
298
|
-
api_response = await api_instance.read_backends_backends_get(latest=latest, id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat)
|
|
310
|
+
api_response = await api_instance.read_backends_backends_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat)
|
|
299
311
|
print("The response of BackendApi->read_backends_backends_get:\n")
|
|
300
312
|
pprint(api_response)
|
|
301
313
|
except Exception as e:
|
|
@@ -309,6 +321,9 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
309
321
|
Name | Type | Description | Notes
|
|
310
322
|
------------- | ------------- | ------------- | -------------
|
|
311
323
|
**latest** | **bool**| | [optional]
|
|
324
|
+
**sort_by** | **str**| | [optional]
|
|
325
|
+
**page_number** | **int**| | [optional]
|
|
326
|
+
**items_per_page** | **int**| | [optional]
|
|
312
327
|
**id** | **int**| | [optional]
|
|
313
328
|
**name** | **str**| | [optional]
|
|
314
329
|
**location** | **str**| | [optional]
|
|
@@ -322,7 +337,7 @@ Name | Type | Description | Notes
|
|
|
322
337
|
|
|
323
338
|
### Authorization
|
|
324
339
|
|
|
325
|
-
[user](../README.md#user)
|
|
340
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
326
341
|
|
|
327
342
|
### HTTP request headers
|
|
328
343
|
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# BackendIn
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **str** | |
|
|
8
|
+
**location** | **str** | |
|
|
9
|
+
**backend_type_id** | **int** | |
|
|
10
|
+
**status** | [**BackendStatus**](BackendStatus.md) | |
|
|
11
|
+
**last_heartbeat** | **datetime** | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```python
|
|
16
|
+
from compute_api_client.models.backend_in import BackendIn
|
|
17
|
+
|
|
18
|
+
# TODO update the JSON string below
|
|
19
|
+
json = "{}"
|
|
20
|
+
# create an instance of BackendIn from a JSON string
|
|
21
|
+
backend_in_instance = BackendIn.from_json(json)
|
|
22
|
+
# print the JSON string representation of the object
|
|
23
|
+
print BackendIn.to_json()
|
|
24
|
+
|
|
25
|
+
# convert the object into a dict
|
|
26
|
+
backend_in_dict = backend_in_instance.to_dict()
|
|
27
|
+
# create an instance of BackendIn from a dict
|
|
28
|
+
backend_in_form_dict = backend_in.from_dict(backend_in_dict)
|
|
29
|
+
```
|
|
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)
|
|
31
|
+
|
|
32
|
+
|
|
@@ -13,6 +13,9 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**features** | **List[str]** | |
|
|
14
14
|
**default_compiler_config** | **object** | |
|
|
15
15
|
**native_gateset** | **object** | |
|
|
16
|
+
**status** | [**BackendStatus**](BackendStatus.md) | |
|
|
17
|
+
**default_number_of_shots** | **int** | |
|
|
18
|
+
**max_number_of_shots** | **int** | |
|
|
16
19
|
|
|
17
20
|
## Example
|
|
18
21
|
|
|
@@ -17,6 +17,7 @@ Get backend type by ID.
|
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
20
|
+
* OAuth Authentication (user_bearer):
|
|
20
21
|
* Api Key Authentication (user):
|
|
21
22
|
```python
|
|
22
23
|
import time
|
|
@@ -37,6 +38,8 @@ configuration = compute_api_client.Configuration(
|
|
|
37
38
|
# Examples for each auth method are provided below, use the example that
|
|
38
39
|
# satisfies your auth use case.
|
|
39
40
|
|
|
41
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
42
|
+
|
|
40
43
|
# Configure API key authorization: user
|
|
41
44
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
42
45
|
|
|
@@ -72,7 +75,7 @@ Name | Type | Description | Notes
|
|
|
72
75
|
|
|
73
76
|
### Authorization
|
|
74
77
|
|
|
75
|
-
[user](../README.md#user)
|
|
78
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
76
79
|
|
|
77
80
|
### HTTP request headers
|
|
78
81
|
|
|
@@ -89,7 +92,7 @@ Name | Type | Description | Notes
|
|
|
89
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)
|
|
90
93
|
|
|
91
94
|
# **read_backend_types_backend_types_get**
|
|
92
|
-
> List[BackendType] read_backend_types_backend_types_get(latest=latest, id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware)
|
|
95
|
+
> List[BackendType] read_backend_types_backend_types_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots)
|
|
93
96
|
|
|
94
97
|
List backend types
|
|
95
98
|
|
|
@@ -97,11 +100,13 @@ Read backend types.
|
|
|
97
100
|
|
|
98
101
|
### Example
|
|
99
102
|
|
|
103
|
+
* OAuth Authentication (user_bearer):
|
|
100
104
|
* Api Key Authentication (user):
|
|
101
105
|
```python
|
|
102
106
|
import time
|
|
103
107
|
import os
|
|
104
108
|
import compute_api_client
|
|
109
|
+
from compute_api_client.models.backend_status import BackendStatus
|
|
105
110
|
from compute_api_client.models.backend_type import BackendType
|
|
106
111
|
from compute_api_client.rest import ApiException
|
|
107
112
|
from pprint import pprint
|
|
@@ -117,6 +122,8 @@ configuration = compute_api_client.Configuration(
|
|
|
117
122
|
# Examples for each auth method are provided below, use the example that
|
|
118
123
|
# satisfies your auth use case.
|
|
119
124
|
|
|
125
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
126
|
+
|
|
120
127
|
# Configure API key authorization: user
|
|
121
128
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
122
129
|
|
|
@@ -128,16 +135,22 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
128
135
|
# Create an instance of the API class
|
|
129
136
|
api_instance = compute_api_client.BackendTypesApi(api_client)
|
|
130
137
|
latest = True # bool | (optional)
|
|
138
|
+
sort_by = 'sort_by_example' # str | (optional)
|
|
139
|
+
page_number = 56 # int | (optional)
|
|
140
|
+
items_per_page = 56 # int | (optional)
|
|
131
141
|
id = 56 # int | (optional)
|
|
132
142
|
name = 'name_example' # str | (optional)
|
|
133
143
|
infrastructure = 'infrastructure_example' # str | (optional)
|
|
134
144
|
description = 'description_example' # str | (optional)
|
|
135
145
|
image_id = 'image_id_example' # str | (optional)
|
|
136
146
|
is_hardware = True # bool | (optional)
|
|
147
|
+
status = compute_api_client.BackendStatus() # BackendStatus | (optional)
|
|
148
|
+
default_number_of_shots = 56 # int | (optional)
|
|
149
|
+
max_number_of_shots = 56 # int | (optional)
|
|
137
150
|
|
|
138
151
|
try:
|
|
139
152
|
# List backend types
|
|
140
|
-
api_response = await api_instance.read_backend_types_backend_types_get(latest=latest, id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware)
|
|
153
|
+
api_response = await api_instance.read_backend_types_backend_types_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots)
|
|
141
154
|
print("The response of BackendTypesApi->read_backend_types_backend_types_get:\n")
|
|
142
155
|
pprint(api_response)
|
|
143
156
|
except Exception as e:
|
|
@@ -151,12 +164,18 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
151
164
|
Name | Type | Description | Notes
|
|
152
165
|
------------- | ------------- | ------------- | -------------
|
|
153
166
|
**latest** | **bool**| | [optional]
|
|
167
|
+
**sort_by** | **str**| | [optional]
|
|
168
|
+
**page_number** | **int**| | [optional]
|
|
169
|
+
**items_per_page** | **int**| | [optional]
|
|
154
170
|
**id** | **int**| | [optional]
|
|
155
171
|
**name** | **str**| | [optional]
|
|
156
172
|
**infrastructure** | **str**| | [optional]
|
|
157
173
|
**description** | **str**| | [optional]
|
|
158
174
|
**image_id** | **str**| | [optional]
|
|
159
175
|
**is_hardware** | **bool**| | [optional]
|
|
176
|
+
**status** | [**BackendStatus**](.md)| | [optional]
|
|
177
|
+
**default_number_of_shots** | **int**| | [optional]
|
|
178
|
+
**max_number_of_shots** | **int**| | [optional]
|
|
160
179
|
|
|
161
180
|
### Return type
|
|
162
181
|
|
|
@@ -164,7 +183,7 @@ Name | Type | Description | Notes
|
|
|
164
183
|
|
|
165
184
|
### Authorization
|
|
166
185
|
|
|
167
|
-
[user](../README.md#user)
|
|
186
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
168
187
|
|
|
169
188
|
### HTTP request headers
|
|
170
189
|
|
|
@@ -10,6 +10,7 @@ Method | HTTP request | Description
|
|
|
10
10
|
[**peek_batch_job_batch_jobs_peek_patch**](BatchJobsApi.md#peek_batch_job_batch_jobs_peek_patch) | **PATCH** /batch_jobs/peek | Peek batch job
|
|
11
11
|
[**pop_batch_job_batch_jobs_pop_patch**](BatchJobsApi.md#pop_batch_job_batch_jobs_pop_patch) | **PATCH** /batch_jobs/pop | Take batch job
|
|
12
12
|
[**read_batch_jobs_batch_jobs_get**](BatchJobsApi.md#read_batch_jobs_batch_jobs_get) | **GET** /batch_jobs | List batch jobs
|
|
13
|
+
[**unpop_batch_job_batch_jobs_unpop_patch**](BatchJobsApi.md#unpop_batch_job_batch_jobs_unpop_patch) | **PATCH** /batch_jobs/unpop | Take batch job
|
|
13
14
|
|
|
14
15
|
|
|
15
16
|
# **create_batch_job_batch_jobs_post**
|
|
@@ -21,6 +22,7 @@ Create new batch job.
|
|
|
21
22
|
|
|
22
23
|
### Example
|
|
23
24
|
|
|
25
|
+
* OAuth Authentication (user_bearer):
|
|
24
26
|
* Api Key Authentication (user):
|
|
25
27
|
```python
|
|
26
28
|
import time
|
|
@@ -42,6 +44,8 @@ configuration = compute_api_client.Configuration(
|
|
|
42
44
|
# Examples for each auth method are provided below, use the example that
|
|
43
45
|
# satisfies your auth use case.
|
|
44
46
|
|
|
47
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
48
|
+
|
|
45
49
|
# Configure API key authorization: user
|
|
46
50
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
47
51
|
|
|
@@ -77,7 +81,7 @@ Name | Type | Description | Notes
|
|
|
77
81
|
|
|
78
82
|
### Authorization
|
|
79
83
|
|
|
80
|
-
[user](../README.md#user)
|
|
84
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
81
85
|
|
|
82
86
|
### HTTP request headers
|
|
83
87
|
|
|
@@ -101,6 +105,7 @@ Enqueue batch job for execution.
|
|
|
101
105
|
|
|
102
106
|
### Example
|
|
103
107
|
|
|
108
|
+
* OAuth Authentication (user_bearer):
|
|
104
109
|
* Api Key Authentication (user):
|
|
105
110
|
```python
|
|
106
111
|
import time
|
|
@@ -121,6 +126,8 @@ configuration = compute_api_client.Configuration(
|
|
|
121
126
|
# Examples for each auth method are provided below, use the example that
|
|
122
127
|
# satisfies your auth use case.
|
|
123
128
|
|
|
129
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
130
|
+
|
|
124
131
|
# Configure API key authorization: user
|
|
125
132
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
126
133
|
|
|
@@ -156,7 +163,7 @@ Name | Type | Description | Notes
|
|
|
156
163
|
|
|
157
164
|
### Authorization
|
|
158
165
|
|
|
159
|
-
[user](../README.md#user)
|
|
166
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
160
167
|
|
|
161
168
|
### HTTP request headers
|
|
162
169
|
|
|
@@ -181,6 +188,7 @@ Finish batch job.
|
|
|
181
188
|
|
|
182
189
|
### Example
|
|
183
190
|
|
|
191
|
+
* OAuth Authentication (user_bearer):
|
|
184
192
|
* Api Key Authentication (backend):
|
|
185
193
|
* Api Key Authentication (user):
|
|
186
194
|
```python
|
|
@@ -202,6 +210,8 @@ configuration = compute_api_client.Configuration(
|
|
|
202
210
|
# Examples for each auth method are provided below, use the example that
|
|
203
211
|
# satisfies your auth use case.
|
|
204
212
|
|
|
213
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
214
|
+
|
|
205
215
|
# Configure API key authorization: backend
|
|
206
216
|
configuration.api_key['backend'] = os.environ["API_KEY"]
|
|
207
217
|
|
|
@@ -243,7 +253,7 @@ Name | Type | Description | Notes
|
|
|
243
253
|
|
|
244
254
|
### Authorization
|
|
245
255
|
|
|
246
|
-
[backend](../README.md#backend), [user](../README.md#user)
|
|
256
|
+
[user_bearer](../README.md#user_bearer), [backend](../README.md#backend), [user](../README.md#user)
|
|
247
257
|
|
|
248
258
|
### HTTP request headers
|
|
249
259
|
|
|
@@ -343,7 +353,7 @@ Name | Type | Description | Notes
|
|
|
343
353
|
|
|
344
354
|
Take batch job
|
|
345
355
|
|
|
346
|
-
Claim batch job
|
|
356
|
+
Claim batch job.
|
|
347
357
|
|
|
348
358
|
### Example
|
|
349
359
|
|
|
@@ -414,7 +424,7 @@ This endpoint does not need any parameter.
|
|
|
414
424
|
[[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)
|
|
415
425
|
|
|
416
426
|
# **read_batch_jobs_batch_jobs_get**
|
|
417
|
-
> List[BatchJob] read_batch_jobs_batch_jobs_get(latest=latest, id=id, created_on=created_on, status=status, user_id=user_id, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, reserved_at__isnull=reserved_at__isnull, reserved_at=reserved_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, aggregated_algorithm_type=aggregated_algorithm_type)
|
|
427
|
+
> List[BatchJob] read_batch_jobs_batch_jobs_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, status=status, user_id=user_id, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, reserved_at__isnull=reserved_at__isnull, reserved_at=reserved_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, aggregated_algorithm_type=aggregated_algorithm_type)
|
|
418
428
|
|
|
419
429
|
List batch jobs
|
|
420
430
|
|
|
@@ -422,6 +432,7 @@ List batch jobs.
|
|
|
422
432
|
|
|
423
433
|
### Example
|
|
424
434
|
|
|
435
|
+
* OAuth Authentication (user_bearer):
|
|
425
436
|
* Api Key Authentication (user):
|
|
426
437
|
```python
|
|
427
438
|
import time
|
|
@@ -444,6 +455,8 @@ configuration = compute_api_client.Configuration(
|
|
|
444
455
|
# Examples for each auth method are provided below, use the example that
|
|
445
456
|
# satisfies your auth use case.
|
|
446
457
|
|
|
458
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
459
|
+
|
|
447
460
|
# Configure API key authorization: user
|
|
448
461
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
449
462
|
|
|
@@ -455,6 +468,9 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
455
468
|
# Create an instance of the API class
|
|
456
469
|
api_instance = compute_api_client.BatchJobsApi(api_client)
|
|
457
470
|
latest = True # bool | (optional)
|
|
471
|
+
sort_by = 'sort_by_example' # str | (optional)
|
|
472
|
+
page_number = 56 # int | (optional)
|
|
473
|
+
items_per_page = 56 # int | (optional)
|
|
458
474
|
id = 56 # int | (optional)
|
|
459
475
|
created_on = '2013-10-20T19:20:30+01:00' # datetime | (optional)
|
|
460
476
|
status = compute_api_client.BatchJobStatus() # BatchJobStatus | (optional)
|
|
@@ -472,7 +488,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
472
488
|
|
|
473
489
|
try:
|
|
474
490
|
# List batch jobs
|
|
475
|
-
api_response = await api_instance.read_batch_jobs_batch_jobs_get(latest=latest, id=id, created_on=created_on, status=status, user_id=user_id, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, reserved_at__isnull=reserved_at__isnull, reserved_at=reserved_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, aggregated_algorithm_type=aggregated_algorithm_type)
|
|
491
|
+
api_response = await api_instance.read_batch_jobs_batch_jobs_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, status=status, user_id=user_id, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, reserved_at__isnull=reserved_at__isnull, reserved_at=reserved_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, aggregated_algorithm_type=aggregated_algorithm_type)
|
|
476
492
|
print("The response of BatchJobsApi->read_batch_jobs_batch_jobs_get:\n")
|
|
477
493
|
pprint(api_response)
|
|
478
494
|
except Exception as e:
|
|
@@ -486,6 +502,9 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
486
502
|
Name | Type | Description | Notes
|
|
487
503
|
------------- | ------------- | ------------- | -------------
|
|
488
504
|
**latest** | **bool**| | [optional]
|
|
505
|
+
**sort_by** | **str**| | [optional]
|
|
506
|
+
**page_number** | **int**| | [optional]
|
|
507
|
+
**items_per_page** | **int**| | [optional]
|
|
489
508
|
**id** | **int**| | [optional]
|
|
490
509
|
**created_on** | **datetime**| | [optional]
|
|
491
510
|
**status** | [**BatchJobStatus**](.md)| | [optional]
|
|
@@ -507,7 +526,7 @@ Name | Type | Description | Notes
|
|
|
507
526
|
|
|
508
527
|
### Authorization
|
|
509
528
|
|
|
510
|
-
[user](../README.md#user)
|
|
529
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
511
530
|
|
|
512
531
|
### HTTP request headers
|
|
513
532
|
|
|
@@ -522,3 +541,78 @@ Name | Type | Description | Notes
|
|
|
522
541
|
|
|
523
542
|
[[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)
|
|
524
543
|
|
|
544
|
+
# **unpop_batch_job_batch_jobs_unpop_patch**
|
|
545
|
+
> BatchJob unpop_batch_job_batch_jobs_unpop_patch()
|
|
546
|
+
|
|
547
|
+
Take batch job
|
|
548
|
+
|
|
549
|
+
Unclaim batch job.
|
|
550
|
+
|
|
551
|
+
### Example
|
|
552
|
+
|
|
553
|
+
* Api Key Authentication (backend):
|
|
554
|
+
```python
|
|
555
|
+
import time
|
|
556
|
+
import os
|
|
557
|
+
import compute_api_client
|
|
558
|
+
from compute_api_client.models.batch_job import BatchJob
|
|
559
|
+
from compute_api_client.rest import ApiException
|
|
560
|
+
from pprint import pprint
|
|
561
|
+
|
|
562
|
+
# Defining the host is optional and defaults to http://localhost
|
|
563
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
564
|
+
configuration = compute_api_client.Configuration(
|
|
565
|
+
host = "http://localhost"
|
|
566
|
+
)
|
|
567
|
+
|
|
568
|
+
# The client must configure the authentication and authorization parameters
|
|
569
|
+
# in accordance with the API server security policy.
|
|
570
|
+
# Examples for each auth method are provided below, use the example that
|
|
571
|
+
# satisfies your auth use case.
|
|
572
|
+
|
|
573
|
+
# Configure API key authorization: backend
|
|
574
|
+
configuration.api_key['backend'] = os.environ["API_KEY"]
|
|
575
|
+
|
|
576
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
577
|
+
# configuration.api_key_prefix['backend'] = 'Bearer'
|
|
578
|
+
|
|
579
|
+
# Enter a context with an instance of the API client
|
|
580
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
581
|
+
# Create an instance of the API class
|
|
582
|
+
api_instance = compute_api_client.BatchJobsApi(api_client)
|
|
583
|
+
|
|
584
|
+
try:
|
|
585
|
+
# Take batch job
|
|
586
|
+
api_response = await api_instance.unpop_batch_job_batch_jobs_unpop_patch()
|
|
587
|
+
print("The response of BatchJobsApi->unpop_batch_job_batch_jobs_unpop_patch:\n")
|
|
588
|
+
pprint(api_response)
|
|
589
|
+
except Exception as e:
|
|
590
|
+
print("Exception when calling BatchJobsApi->unpop_batch_job_batch_jobs_unpop_patch: %s\n" % e)
|
|
591
|
+
```
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
### Parameters
|
|
596
|
+
This endpoint does not need any parameter.
|
|
597
|
+
|
|
598
|
+
### Return type
|
|
599
|
+
|
|
600
|
+
[**BatchJob**](BatchJob.md)
|
|
601
|
+
|
|
602
|
+
### Authorization
|
|
603
|
+
|
|
604
|
+
[backend](../README.md#backend)
|
|
605
|
+
|
|
606
|
+
### HTTP request headers
|
|
607
|
+
|
|
608
|
+
- **Content-Type**: Not defined
|
|
609
|
+
- **Accept**: application/json
|
|
610
|
+
|
|
611
|
+
### HTTP response details
|
|
612
|
+
| Status code | Description | Response headers |
|
|
613
|
+
|-------------|-------------|------------------|
|
|
614
|
+
**200** | Successful Response | - |
|
|
615
|
+
**404** | Not Found | - |
|
|
616
|
+
|
|
617
|
+
[[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)
|
|
618
|
+
|
|
@@ -19,6 +19,7 @@ Create new commit.
|
|
|
19
19
|
|
|
20
20
|
### Example
|
|
21
21
|
|
|
22
|
+
* OAuth Authentication (user_bearer):
|
|
22
23
|
* Api Key Authentication (user):
|
|
23
24
|
```python
|
|
24
25
|
import time
|
|
@@ -40,6 +41,8 @@ configuration = compute_api_client.Configuration(
|
|
|
40
41
|
# Examples for each auth method are provided below, use the example that
|
|
41
42
|
# satisfies your auth use case.
|
|
42
43
|
|
|
44
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
45
|
+
|
|
43
46
|
# Configure API key authorization: user
|
|
44
47
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
45
48
|
|
|
@@ -75,7 +78,7 @@ Name | Type | Description | Notes
|
|
|
75
78
|
|
|
76
79
|
### Authorization
|
|
77
80
|
|
|
78
|
-
[user](../README.md#user)
|
|
81
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
79
82
|
|
|
80
83
|
### HTTP request headers
|
|
81
84
|
|
|
@@ -99,6 +102,7 @@ Delete a commit.
|
|
|
99
102
|
|
|
100
103
|
### Example
|
|
101
104
|
|
|
105
|
+
* OAuth Authentication (user_bearer):
|
|
102
106
|
* Api Key Authentication (user):
|
|
103
107
|
```python
|
|
104
108
|
import time
|
|
@@ -118,6 +122,8 @@ configuration = compute_api_client.Configuration(
|
|
|
118
122
|
# Examples for each auth method are provided below, use the example that
|
|
119
123
|
# satisfies your auth use case.
|
|
120
124
|
|
|
125
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
126
|
+
|
|
121
127
|
# Configure API key authorization: user
|
|
122
128
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
123
129
|
|
|
@@ -151,7 +157,7 @@ void (empty response body)
|
|
|
151
157
|
|
|
152
158
|
### Authorization
|
|
153
159
|
|
|
154
|
-
[user](../README.md#user)
|
|
160
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
155
161
|
|
|
156
162
|
### HTTP request headers
|
|
157
163
|
|
|
@@ -176,6 +182,7 @@ Get commit by ID.
|
|
|
176
182
|
|
|
177
183
|
### Example
|
|
178
184
|
|
|
185
|
+
* OAuth Authentication (user_bearer):
|
|
179
186
|
* Api Key Authentication (backend):
|
|
180
187
|
* Api Key Authentication (user):
|
|
181
188
|
```python
|
|
@@ -197,6 +204,8 @@ configuration = compute_api_client.Configuration(
|
|
|
197
204
|
# Examples for each auth method are provided below, use the example that
|
|
198
205
|
# satisfies your auth use case.
|
|
199
206
|
|
|
207
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
208
|
+
|
|
200
209
|
# Configure API key authorization: backend
|
|
201
210
|
configuration.api_key['backend'] = os.environ["API_KEY"]
|
|
202
211
|
|
|
@@ -238,7 +247,7 @@ Name | Type | Description | Notes
|
|
|
238
247
|
|
|
239
248
|
### Authorization
|
|
240
249
|
|
|
241
|
-
[backend](../README.md#backend), [user](../README.md#user)
|
|
250
|
+
[user_bearer](../README.md#user_bearer), [backend](../README.md#backend), [user](../README.md#user)
|
|
242
251
|
|
|
243
252
|
### HTTP request headers
|
|
244
253
|
|
|
@@ -255,7 +264,7 @@ Name | Type | Description | Notes
|
|
|
255
264
|
[[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)
|
|
256
265
|
|
|
257
266
|
# **read_commits_commits_get**
|
|
258
|
-
> List[Commit] read_commits_commits_get(latest=latest, id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id)
|
|
267
|
+
> List[Commit] read_commits_commits_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id)
|
|
259
268
|
|
|
260
269
|
List commits
|
|
261
270
|
|
|
@@ -263,6 +272,7 @@ List commits.
|
|
|
263
272
|
|
|
264
273
|
### Example
|
|
265
274
|
|
|
275
|
+
* OAuth Authentication (user_bearer):
|
|
266
276
|
* Api Key Authentication (user):
|
|
267
277
|
```python
|
|
268
278
|
import time
|
|
@@ -283,6 +293,8 @@ configuration = compute_api_client.Configuration(
|
|
|
283
293
|
# Examples for each auth method are provided below, use the example that
|
|
284
294
|
# satisfies your auth use case.
|
|
285
295
|
|
|
296
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
297
|
+
|
|
286
298
|
# Configure API key authorization: user
|
|
287
299
|
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
288
300
|
|
|
@@ -294,6 +306,9 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
294
306
|
# Create an instance of the API class
|
|
295
307
|
api_instance = compute_api_client.CommitsApi(api_client)
|
|
296
308
|
latest = True # bool | (optional)
|
|
309
|
+
sort_by = 'sort_by_example' # str | (optional)
|
|
310
|
+
page_number = 56 # int | (optional)
|
|
311
|
+
items_per_page = 56 # int | (optional)
|
|
297
312
|
id = 56 # int | (optional)
|
|
298
313
|
created_on = '2013-10-20T19:20:30+01:00' # datetime | (optional)
|
|
299
314
|
hash = 'hash_example' # str | (optional)
|
|
@@ -302,7 +317,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
302
317
|
|
|
303
318
|
try:
|
|
304
319
|
# List commits
|
|
305
|
-
api_response = await api_instance.read_commits_commits_get(latest=latest, id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id)
|
|
320
|
+
api_response = await api_instance.read_commits_commits_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id)
|
|
306
321
|
print("The response of CommitsApi->read_commits_commits_get:\n")
|
|
307
322
|
pprint(api_response)
|
|
308
323
|
except Exception as e:
|
|
@@ -316,6 +331,9 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
316
331
|
Name | Type | Description | Notes
|
|
317
332
|
------------- | ------------- | ------------- | -------------
|
|
318
333
|
**latest** | **bool**| | [optional]
|
|
334
|
+
**sort_by** | **str**| | [optional]
|
|
335
|
+
**page_number** | **int**| | [optional]
|
|
336
|
+
**items_per_page** | **int**| | [optional]
|
|
319
337
|
**id** | **int**| | [optional]
|
|
320
338
|
**created_on** | **datetime**| | [optional]
|
|
321
339
|
**hash** | **str**| | [optional]
|
|
@@ -328,7 +346,7 @@ Name | Type | Description | Notes
|
|
|
328
346
|
|
|
329
347
|
### Authorization
|
|
330
348
|
|
|
331
|
-
[user](../README.md#user)
|
|
349
|
+
[user_bearer](../README.md#user_bearer), [user](../README.md#user)
|
|
332
350
|
|
|
333
351
|
### HTTP request headers
|
|
334
352
|
|