qi-compute-api-client 0.56.0__py3-none-any.whl

compute_api_client/docs/BackendApi.md

@@ -0,0 +1,418 @@
+# compute_api_client.BackendApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_backend_backends_post**](BackendApi.md#create_backend_backends_post) | **POST** /backends | Create backend
+[**read_backend_backends_id_get**](BackendApi.md#read_backend_backends_id_get) | **GET** /backends/{id} | Retrieve backend
+[**read_backend_self_backends_me_get**](BackendApi.md#read_backend_self_backends_me_get) | **GET** /backends/me | Retrieve backend
+[**read_backends_backends_get**](BackendApi.md#read_backends_backends_get) | **GET** /backends | List backends
+[**update_backend_self_backends_me_patch**](BackendApi.md#update_backend_self_backends_me_patch) | **PATCH** /backends/me | Update backend
+
+
+# **create_backend_backends_post**
+> BackendWithAuthentication create_backend_backends_post(backend_in)
+
+Create backend
+
+Create new backend.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+import compute_api_client
+from compute_api_client.models.backend_in import BackendIn
+from compute_api_client.models.backend_with_authentication import BackendWithAuthentication
+from compute_api_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = compute_api_client.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+async with compute_api_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = compute_api_client.BackendApi(api_client)
+    backend_in = compute_api_client.BackendIn() # BackendIn | 
+
+    try:
+        # Create backend
+        api_response = await api_instance.create_backend_backends_post(backend_in)
+        print("The response of BackendApi->create_backend_backends_post:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling BackendApi->create_backend_backends_post: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **backend_in** | [**BackendIn**](BackendIn.md)|  | 
+
+### Return type
+
+[**BackendWithAuthentication**](BackendWithAuthentication.md)
+
+### Authorization
+
+[user_bearer](../README.md#user_bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**201** | Successful Response |  -  |
+**422** | Validation Error |  -  |
+
+[[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)
+
+# **read_backend_backends_id_get**
+> Backend read_backend_backends_id_get(id)
+
+Retrieve backend
+
+Get backend by ID.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+import compute_api_client
+from compute_api_client.models.backend import Backend
+from compute_api_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = compute_api_client.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+async with compute_api_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = compute_api_client.BackendApi(api_client)
+    id = 56 # int | 
+
+    try:
+        # Retrieve backend
+        api_response = await api_instance.read_backend_backends_id_get(id)
+        print("The response of BackendApi->read_backend_backends_id_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling BackendApi->read_backend_backends_id_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | 
+
+### Return type
+
+[**Backend**](Backend.md)
+
+### Authorization
+
+[user_bearer](../README.md#user_bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**404** | Not Found |  -  |
+**422** | Validation Error |  -  |
+
+[[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)
+
+# **read_backend_self_backends_me_get**
+> Backend read_backend_self_backends_me_get()
+
+Retrieve backend
+
+Read backend.
+
+### Example
+
+* Api Key Authentication (backend):
+
+```python
+import compute_api_client
+from compute_api_client.models.backend import Backend
+from compute_api_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = compute_api_client.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: backend
+configuration.api_key['backend'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['backend'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+async with compute_api_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = compute_api_client.BackendApi(api_client)
+
+    try:
+        # Retrieve backend
+        api_response = await api_instance.read_backend_self_backends_me_get()
+        print("The response of BackendApi->read_backend_self_backends_me_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling BackendApi->read_backend_self_backends_me_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Backend**](Backend.md)
+
+### Authorization
+
+[backend](../README.md#backend)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+
+[[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)
+
+# **read_backends_backends_get**
+> PageBackend read_backends_backends_get(id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat, sort_by=sort_by, latest=latest, page=page, size=size)
+
+List backends
+
+Read backends.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+import compute_api_client
+from compute_api_client.models.backend_status import BackendStatus
+from compute_api_client.models.page_backend import PageBackend
+from compute_api_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = compute_api_client.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+async with compute_api_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = compute_api_client.BackendApi(api_client)
+    id = 56 # int |  (optional)
+    name = 'name_example' # str |  (optional)
+    location = 'location_example' # str |  (optional)
+    backend_type_id = 56 # int |  (optional)
+    status = compute_api_client.BackendStatus() # BackendStatus |  (optional)
+    last_heartbeat = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
+    sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional)
+    latest = True # bool | If True gets the most recently created object. (optional)
+    page = 1 # int | Page number (optional) (default to 1)
+    size = 50 # int | Page size (optional) (default to 50)
+
+    try:
+        # List backends
+        api_response = await api_instance.read_backends_backends_get(id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat, sort_by=sort_by, latest=latest, page=page, size=size)
+        print("The response of BackendApi->read_backends_backends_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling BackendApi->read_backends_backends_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | [optional] 
+ **name** | **str**|  | [optional] 
+ **location** | **str**|  | [optional] 
+ **backend_type_id** | **int**|  | [optional] 
+ **status** | [**BackendStatus**](.md)|  | [optional] 
+ **last_heartbeat** | **datetime**|  | [optional] 
+ **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] 
+ **latest** | **bool**| If True gets the most recently created object. | [optional] 
+ **page** | **int**| Page number | [optional] [default to 1]
+ **size** | **int**| Page size | [optional] [default to 50]
+
+### Return type
+
+[**PageBackend**](PageBackend.md)
+
+### Authorization
+
+[user_bearer](../README.md#user_bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**422** | Validation Error |  -  |
+
+[[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)
+
+# **update_backend_self_backends_me_patch**
+> Backend update_backend_self_backends_me_patch(backend_patch)
+
+Update backend
+
+Update backend.
+
+### Example
+
+* Api Key Authentication (backend):
+
+```python
+import compute_api_client
+from compute_api_client.models.backend import Backend
+from compute_api_client.models.backend_patch import BackendPatch
+from compute_api_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = compute_api_client.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: backend
+configuration.api_key['backend'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['backend'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+async with compute_api_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = compute_api_client.BackendApi(api_client)
+    backend_patch = compute_api_client.BackendPatch() # BackendPatch | 
+
+    try:
+        # Update backend
+        api_response = await api_instance.update_backend_self_backends_me_patch(backend_patch)
+        print("The response of BackendApi->update_backend_self_backends_me_patch:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling BackendApi->update_backend_self_backends_me_patch: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **backend_patch** | [**BackendPatch**](BackendPatch.md)|  | 
+
+### Return type
+
+[**Backend**](Backend.md)
+
+### Authorization
+
+[backend](../README.md#backend)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**422** | Validation Error |  -  |
+
+[[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)
+

compute_api_client/docs/BackendIn.md

@@ -0,0 +1,34 @@
+# BackendIn
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | The name of the backend | 
+**location** | **str** | The location of the backend | 
+**backend_type_id** | **int** | The id of the backend type | 
+**status** | [**BackendStatus**](BackendStatus.md) | Status of the backend | 
+**last_heartbeat** | **datetime** | Time of last heartbeat | 
+**message** | [**BackendMessage**](BackendMessage.md) | The message obj for a backend | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.backend_in import BackendIn
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BackendIn from a JSON string
+backend_in_instance = BackendIn.from_json(json)
+# print the JSON string representation of the object
+print(BackendIn.to_json())
+
+# convert the object into a dict
+backend_in_dict = backend_in_instance.to_dict()
+# create an instance of BackendIn from a dict
+backend_in_from_dict = BackendIn.from_dict(backend_in_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/BackendMessage.md

@@ -0,0 +1,29 @@
+# BackendMessage
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **str** | Content of the message | [optional] [default to '']
+
+## Example
+
+```python
+from compute_api_client.models.backend_message import BackendMessage
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BackendMessage from a JSON string
+backend_message_instance = BackendMessage.from_json(json)
+# print the JSON string representation of the object
+print(BackendMessage.to_json())
+
+# convert the object into a dict
+backend_message_dict = backend_message_instance.to_dict()
+# create an instance of BackendMessage from a dict
+backend_message_from_dict = BackendMessage.from_dict(backend_message_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/BackendPatch.md

@@ -0,0 +1,31 @@
+# BackendPatch
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | [**BackendMessage**](BackendMessage.md) |  | [optional] 
+**status** | [**BackendStatus**](BackendStatus.md) |  | [optional] 
+**last_heartbeat** | **datetime** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.backend_patch import BackendPatch
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BackendPatch from a JSON string
+backend_patch_instance = BackendPatch.from_json(json)
+# print the JSON string representation of the object
+print(BackendPatch.to_json())
+
+# convert the object into a dict
+backend_patch_dict = backend_patch_instance.to_dict()
+# create an instance of BackendPatch from a dict
+backend_patch_from_dict = BackendPatch.from_dict(backend_patch_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/BackendStatus.md

@@ -0,0 +1,16 @@
+# BackendStatus
+
+
+## Enum
+
+* `OFFLINE` (value: `'offline'`)
+
+* `IDLE` (value: `'idle'`)
+
+* `EXECUTING` (value: `'executing'`)
+
+* `CALIBRATING` (value: `'calibrating'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/BackendType.md

@@ -0,0 +1,48 @@
+# BackendType
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | The id of the backend type | 
+**name** | **str** | Name of the backend type | 
+**infrastructure** | **str** | Name of the infrastructure | 
+**description** | **str** | Description of the backendtype | 
+**image_id** | **str** | The id of the image | 
+**is_hardware** | **bool** | If it is hardware | 
+**supports_raw_data** | **bool** | If it supports raw data extraction | 
+**features** | **List[Optional[str]]** | The features supported by backend type | 
+**default_compiler_config** | **Dict[str, object]** | The various passes for each stage | 
+**gateset** | **List[Optional[str]]** | The primary gatesets supported by the backend | 
+**topology** | **List[List[int]]** | The topology of the backend | 
+**nqubits** | **int** | The number of qubits on the backend | 
+**status** | [**BackendStatus**](BackendStatus.md) | The status of the backend type | 
+**messages** | [**Dict[str, BackendMessage]**](BackendMessage.md) | List of status messages for the various instances | 
+**default_number_of_shots** | **int** | The default shots | 
+**max_number_of_shots** | **int** | The maximum number of shots | 
+**enabled** | **bool** | If it is enabled | 
+**identifier** | **str** | The identifier of the backend | 
+**protocol_version** | **int** |  | [optional] 
+**job_execution_time_limit** | **float** | Maximum allowed execution time(seconds) for a job. | 
+
+## Example
+
+```python
+from compute_api_client.models.backend_type import BackendType
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BackendType from a JSON string
+backend_type_instance = BackendType.from_json(json)
+# print the JSON string representation of the object
+print(BackendType.to_json())
+
+# convert the object into a dict
+backend_type_dict = backend_type_instance.to_dict()
+# create an instance of BackendType from a dict
+backend_type_from_dict = BackendType.from_dict(backend_type_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/BackendTypePatch.md

@@ -0,0 +1,45 @@
+# BackendTypePatch
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | [optional] 
+**infrastructure** | **str** |  | [optional] 
+**description** | **str** |  | [optional] 
+**image_id** | **str** |  | [optional] 
+**is_hardware** | **bool** |  | [optional] 
+**supports_raw_data** | **bool** |  | [optional] 
+**features** | **List[str]** |  | [optional] 
+**default_compiler_config** | **Dict[str, object]** |  | [optional] 
+**gateset** | **List[str]** |  | [optional] 
+**topology** | **List[List[int]]** |  | [optional] 
+**nqubits** | **int** |  | [optional] 
+**default_number_of_shots** | **int** |  | [optional] 
+**max_number_of_shots** | **int** |  | [optional] 
+**enabled** | **bool** |  | [optional] 
+**identifier** | **str** |  | [optional] 
+**protocol_version** | **int** |  | [optional] 
+**job_execution_time_limit** | **float** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.backend_type_patch import BackendTypePatch
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BackendTypePatch from a JSON string
+backend_type_patch_instance = BackendTypePatch.from_json(json)
+# print the JSON string representation of the object
+print(BackendTypePatch.to_json())
+
+# convert the object into a dict
+backend_type_patch_dict = backend_type_patch_instance.to_dict()
+# create an instance of BackendTypePatch from a dict
+backend_type_patch_from_dict = BackendTypePatch.from_dict(backend_type_patch_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+