qi-compute-api-client 0.7.0__py3-none-any.whl → 0.17.0__py3-none-any.whl

compute_api_client/api/runtime_types_api.py

@@ -1,303 +0,0 @@
-# coding: utf-8
-
-"""
-    Quantum Inspire 2
-
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
-
-    The version of the OpenAPI document: 0.1.0
-    Generated by: https://openapi-generator.tech
-"""
-
-
-from __future__ import absolute_import
-
-import re  # noqa: F401
-
-# python 2 and python 3 compatibility library
-import six
-
-from compute_api_client.api_client import ApiClient
-from compute_api_client.exceptions import (  # noqa: F401
-    ApiTypeError,
-    ApiValueError
-)
-
-
-class RuntimeTypesApi(object):
-    """NOTE: This class is auto generated by OpenAPI Generator
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
-    """
-
-    def __init__(self, api_client=None):
-        if api_client is None:
-            api_client = ApiClient()
-        self.api_client = api_client
-
-    def read_runtime_type_runtime_types_id_get(self, id, **kwargs):  # noqa: E501
-        """Retrieve runtime type  # noqa: E501
-
-        Get runtime type by ID.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.read_runtime_type_runtime_types_id_get(id, async_req=True)
-        >>> result = thread.get()
-
-        :param id: (required)
-        :type id: int
-        :param async_req: Whether to execute the request asynchronously.
-        :type async_req: bool, optional
-        :param _preload_content: if False, the urllib3.HTTPResponse object will
-                                 be returned without reading/decoding response
-                                 data. Default is True.
-        :type _preload_content: bool, optional
-        :param _request_timeout: timeout setting for this request. If one
-                                 number provided, it will be total request
-                                 timeout. It can also be a pair (tuple) of
-                                 (connection, read) timeouts.
-        :return: Returns the result object.
-                 If the method is called asynchronously,
-                 returns the request thread.
-        :rtype: RuntimeType
-        """
-        kwargs['_return_http_data_only'] = True
-        return self.read_runtime_type_runtime_types_id_get_with_http_info(id, **kwargs)  # noqa: E501
-
-    def read_runtime_type_runtime_types_id_get_with_http_info(self, id, **kwargs):  # noqa: E501
-        """Retrieve runtime type  # noqa: E501
-
-        Get runtime type by ID.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.read_runtime_type_runtime_types_id_get_with_http_info(id, async_req=True)
-        >>> result = thread.get()
-
-        :param id: (required)
-        :type id: int
-        :param async_req: Whether to execute the request asynchronously.
-        :type async_req: bool, optional
-        :param _return_http_data_only: response data without head status code
-                                       and headers
-        :type _return_http_data_only: bool, optional
-        :param _preload_content: if False, the urllib3.HTTPResponse object will
-                                 be returned without reading/decoding response
-                                 data. Default is True.
-        :type _preload_content: bool, optional
-        :param _request_timeout: timeout setting for this request. If one
-                                 number provided, it will be total request
-                                 timeout. It can also be a pair (tuple) of
-                                 (connection, read) timeouts.
-        :param _request_auth: set to override the auth_settings for an a single
-                              request; this effectively ignores the authentication
-                              in the spec for a single request.
-        :type _request_auth: dict, optional
-        :type _content_type: string, optional: force content-type for the request
-        :return: Returns the result object.
-                 If the method is called asynchronously,
-                 returns the request thread.
-        :rtype: tuple(RuntimeType, status_code(int), headers(HTTPHeaderDict))
-        """
-
-        local_var_params = locals()
-
-        all_params = [
-            'id'
-        ]
-        all_params.extend(
-            [
-                'async_req',
-                '_return_http_data_only',
-                '_preload_content',
-                '_request_timeout',
-                '_request_auth',
-                '_content_type',
-                '_headers'
-            ]
-        )
-
-        for key, val in six.iteritems(local_var_params['kwargs']):
-            if key not in all_params:
-                raise ApiTypeError(
-                    "Got an unexpected keyword argument '%s'"
-                    " to method read_runtime_type_runtime_types_id_get" % key
-                )
-            local_var_params[key] = val
-        del local_var_params['kwargs']
-        # verify the required parameter 'id' is set
-        if self.api_client.client_side_validation and local_var_params.get('id') is None:  # noqa: E501
-            raise ApiValueError("Missing the required parameter `id` when calling `read_runtime_type_runtime_types_id_get`")  # noqa: E501
-
-        collection_formats = {}
-
-        path_params = {}
-        if 'id' in local_var_params:
-            path_params['id'] = local_var_params['id']  # noqa: E501
-
-        query_params = []
-
-        header_params = dict(local_var_params.get('_headers', {}))
-
-        form_params = []
-        local_var_files = {}
-
-        body_params = None
-        # HTTP header `Accept`
-        header_params['Accept'] = self.api_client.select_header_accept(
-            ['application/json'])  # noqa: E501
-
-        # Authentication setting
-        auth_settings = ['user']  # noqa: E501
-
-        response_types_map = {
-            200: "RuntimeType",
-            404: "HTTPNotFoundError",
-            422: "HTTPValidationError",
-        }
-
-        return self.api_client.call_api(
-            '/runtime_types/{id}', 'GET',
-            path_params,
-            query_params,
-            header_params,
-            body=body_params,
-            post_params=form_params,
-            files=local_var_files,
-            response_types_map=response_types_map,
-            auth_settings=auth_settings,
-            async_req=local_var_params.get('async_req'),
-            _return_http_data_only=local_var_params.get('_return_http_data_only'),  # noqa: E501
-            _preload_content=local_var_params.get('_preload_content', True),
-            _request_timeout=local_var_params.get('_request_timeout'),
-            collection_formats=collection_formats,
-            _request_auth=local_var_params.get('_request_auth'))
-
-    def read_runtime_types_runtime_types_get(self, **kwargs):  # noqa: E501
-        """List runtime types  # noqa: E501
-
-        Read runtime types.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.read_runtime_types_runtime_types_get(async_req=True)
-        >>> result = thread.get()
-
-        :param async_req: Whether to execute the request asynchronously.
-        :type async_req: bool, optional
-        :param _preload_content: if False, the urllib3.HTTPResponse object will
-                                 be returned without reading/decoding response
-                                 data. Default is True.
-        :type _preload_content: bool, optional
-        :param _request_timeout: timeout setting for this request. If one
-                                 number provided, it will be total request
-                                 timeout. It can also be a pair (tuple) of
-                                 (connection, read) timeouts.
-        :return: Returns the result object.
-                 If the method is called asynchronously,
-                 returns the request thread.
-        :rtype: list[RuntimeType]
-        """
-        kwargs['_return_http_data_only'] = True
-        return self.read_runtime_types_runtime_types_get_with_http_info(**kwargs)  # noqa: E501
-
-    def read_runtime_types_runtime_types_get_with_http_info(self, **kwargs):  # noqa: E501
-        """List runtime types  # noqa: E501
-
-        Read runtime types.  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.read_runtime_types_runtime_types_get_with_http_info(async_req=True)
-        >>> result = thread.get()
-
-        :param async_req: Whether to execute the request asynchronously.
-        :type async_req: bool, optional
-        :param _return_http_data_only: response data without head status code
-                                       and headers
-        :type _return_http_data_only: bool, optional
-        :param _preload_content: if False, the urllib3.HTTPResponse object will
-                                 be returned without reading/decoding response
-                                 data. Default is True.
-        :type _preload_content: bool, optional
-        :param _request_timeout: timeout setting for this request. If one
-                                 number provided, it will be total request
-                                 timeout. It can also be a pair (tuple) of
-                                 (connection, read) timeouts.
-        :param _request_auth: set to override the auth_settings for an a single
-                              request; this effectively ignores the authentication
-                              in the spec for a single request.
-        :type _request_auth: dict, optional
-        :type _content_type: string, optional: force content-type for the request
-        :return: Returns the result object.
-                 If the method is called asynchronously,
-                 returns the request thread.
-        :rtype: tuple(list[RuntimeType], status_code(int), headers(HTTPHeaderDict))
-        """
-
-        local_var_params = locals()
-
-        all_params = [
-        ]
-        all_params.extend(
-            [
-                'async_req',
-                '_return_http_data_only',
-                '_preload_content',
-                '_request_timeout',
-                '_request_auth',
-                '_content_type',
-                '_headers'
-            ]
-        )
-
-        for key, val in six.iteritems(local_var_params['kwargs']):
-            if key not in all_params:
-                raise ApiTypeError(
-                    "Got an unexpected keyword argument '%s'"
-                    " to method read_runtime_types_runtime_types_get" % key
-                )
-            local_var_params[key] = val
-        del local_var_params['kwargs']
-
-        collection_formats = {}
-
-        path_params = {}
-
-        query_params = []
-
-        header_params = dict(local_var_params.get('_headers', {}))
-
-        form_params = []
-        local_var_files = {}
-
-        body_params = None
-        # HTTP header `Accept`
-        header_params['Accept'] = self.api_client.select_header_accept(
-            ['application/json'])  # noqa: E501
-
-        # Authentication setting
-        auth_settings = ['user']  # noqa: E501
-
-        response_types_map = {
-            200: "list[RuntimeType]",
-        }
-
-        return self.api_client.call_api(
-            '/runtime_types/', 'GET',
-            path_params,
-            query_params,
-            header_params,
-            body=body_params,
-            post_params=form_params,
-            files=local_var_files,
-            response_types_map=response_types_map,
-            auth_settings=auth_settings,
-            async_req=local_var_params.get('async_req'),
-            _return_http_data_only=local_var_params.get('_return_http_data_only'),  # noqa: E501
-            _preload_content=local_var_params.get('_preload_content', True),
-            _request_timeout=local_var_params.get('_request_timeout'),
-            collection_formats=collection_formats,
-            _request_auth=local_var_params.get('_request_auth'))

compute_api_client/docs/BatchRun.md

@@ -1,21 +0,0 @@
-# BatchRun
-
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**created_on** | **datetime** |  | [readonly] 
-**queued_at** | **datetime** |  | [optional] 
-**finished_at** | **datetime** |  | [optional] 
-**id** | **int** |  | 
-**status** | [**BatchRunStatus**](BatchRunStatus.md) | PLANNED: planned<br/>QUEUED: queued<br/>RESERVED: reserved<br/>RUNNING: running<br/>FINISHED: finished | 
-**reserved_at** | **datetime** |  | [optional] 
-**runtime_id** | **int** |  | [optional] 
-**runtime_type_id** | **int** |  | 
-**user_id** | **int** |  | 
-**run_ids** | **list[int]** |  | 
-**aggregated_algorithm_type** | [**AlgorithmType**](AlgorithmType.md) |  | 
-
-[[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/BatchRunIn.md

@@ -1,12 +0,0 @@
-# BatchRunIn
-
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**runtime_type_id** | **int** |  | 
-**user_id** | **int** |  | 
-
-[[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/Run.md

@@ -1,19 +0,0 @@
-# Run
-
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**created_on** | **datetime** |  | [readonly] 
-**queued_at** | **datetime** |  | [optional] 
-**finished_at** | **datetime** |  | [optional] 
-**id** | **int** |  | 
-**algorithm_type** | [**AlgorithmType**](AlgorithmType.md) | HYBRID: hybrid<br/>QUANTUM: quantum | 
-**status** | [**RunStatus**](RunStatus.md) | PLANNED: planned<br/>RUNNING: running<br/>COMPLETED: completed<br/>CANCELLED: cancelled<br/>FAILED: failed | 
-**number_of_shots** | **int** |  | [optional] 
-**batch_run_id** | **int** |  | 
-**file_id** | **int** |  | 
-
-[[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/RunIn.md

@@ -1,14 +0,0 @@
-# RunIn
-
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**status** | [**RunStatus**](RunStatus.md) | PLANNED: planned<br/>RUNNING: running<br/>COMPLETED: completed<br/>CANCELLED: cancelled<br/>FAILED: failed | [optional] 
-**number_of_shots** | **int** |  | [optional] 
-**batch_run_id** | **int** |  | 
-**file_id** | **int** |  | 
-
-[[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/Runtime.md

@@ -1,16 +0,0 @@
-# Runtime
-
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**name** | **str** |  | 
-**location** | **str** |  | 
-**status** | [**RuntimeStatus**](RuntimeStatus.md) | OFFLINE: offline<br/>IDLE: idle<br/>EXECUTING: executing<br/>CALIBRATING: calibrating | 
-**last_heartbeat** | **datetime** |  | 
-**runtime_type_id** | **int** |  | 
-
-[[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/RuntimeApi.md

@@ -1,229 +0,0 @@
-# compute_api_client.RuntimeApi
-
-All URIs are relative to *http://localhost*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create_runtime_runtimes_post**](RuntimeApi.md#create_runtime_runtimes_post) | **POST** /runtimes | Create runtime
-[**read_runtime_runtimes_id_get**](RuntimeApi.md#read_runtime_runtimes_id_get) | **GET** /runtimes/{id} | Retrieve runtime
-[**read_runtimes_runtimes_get**](RuntimeApi.md#read_runtimes_runtimes_get) | **GET** /runtimes | List runtimes
-
-
-# **create_runtime_runtimes_post**
-> RuntimeWithAuthentication create_runtime_runtimes_post(runtime)
-
-Create runtime
-
-Create new runtime.
-
-### Example
-
-* Api Key Authentication (user):
-```python
-from __future__ import print_function
-import time
-import compute_api_client
-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: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['user'] = 'Bearer'
-
-# Enter a context with an instance of the API client
-with compute_api_client.ApiClient(configuration) as api_client:
-    # Create an instance of the API class
-    api_instance = compute_api_client.RuntimeApi(api_client)
-    runtime = compute_api_client.Runtime() # Runtime | 
-
-    try:
-        # Create runtime
-        api_response = api_instance.create_runtime_runtimes_post(runtime)
-        pprint(api_response)
-    except ApiException as e:
-        print("Exception when calling RuntimeApi->create_runtime_runtimes_post: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **runtime** | [**Runtime**](Runtime.md)|  | 
-
-### Return type
-
-[**RuntimeWithAuthentication**](RuntimeWithAuthentication.md)
-
-### Authorization
-
-[user](../README.md#user)
-
-### 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_runtime_runtimes_id_get**
-> Runtime read_runtime_runtimes_id_get(id)
-
-Retrieve runtime
-
-Get runtime by ID.
-
-### Example
-
-* Api Key Authentication (user):
-```python
-from __future__ import print_function
-import time
-import compute_api_client
-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: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['user'] = 'Bearer'
-
-# Enter a context with an instance of the API client
-with compute_api_client.ApiClient(configuration) as api_client:
-    # Create an instance of the API class
-    api_instance = compute_api_client.RuntimeApi(api_client)
-    id = 56 # int | 
-
-    try:
-        # Retrieve runtime
-        api_response = api_instance.read_runtime_runtimes_id_get(id)
-        pprint(api_response)
-    except ApiException as e:
-        print("Exception when calling RuntimeApi->read_runtime_runtimes_id_get: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **int**|  | 
-
-### Return type
-
-[**Runtime**](Runtime.md)
-
-### Authorization
-
-[user](../README.md#user)
-
-### 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_runtimes_runtimes_get**
-> list[Runtime] read_runtimes_runtimes_get()
-
-List runtimes
-
-Read runtimes.
-
-### Example
-
-* Api Key Authentication (user):
-```python
-from __future__ import print_function
-import time
-import compute_api_client
-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: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['user'] = 'Bearer'
-
-# Enter a context with an instance of the API client
-with compute_api_client.ApiClient(configuration) as api_client:
-    # Create an instance of the API class
-    api_instance = compute_api_client.RuntimeApi(api_client)
-    
-    try:
-        # List runtimes
-        api_response = api_instance.read_runtimes_runtimes_get()
-        pprint(api_response)
-    except ApiException as e:
-        print("Exception when calling RuntimeApi->read_runtimes_runtimes_get: %s\n" % e)
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**list[Runtime]**](Runtime.md)
-
-### Authorization
-
-[user](../README.md#user)
-
-### 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)
-

compute_api_client/docs/RuntimeType.md

@@ -1,19 +0,0 @@
-# RuntimeType
-
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**name** | **str** |  | 
-**infrastructure** | **str** |  | 
-**description** | **str** |  | 
-**image_id** | **str** |  | 
-**is_hardware** | **bool** |  | 
-**features** | **object** |  | [optional] 
-**default_compiler_config** | **object** |  | [optional] 
-**native_gateset** | **object** |  | [optional] 
-
-[[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/RuntimeWithAuthentication.md

@@ -1,17 +0,0 @@
-# RuntimeWithAuthentication
-
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**name** | **str** |  | 
-**location** | **str** |  | 
-**status** | [**RuntimeStatus**](RuntimeStatus.md) | OFFLINE: offline<br/>IDLE: idle<br/>EXECUTING: executing<br/>CALIBRATING: calibrating | 
-**last_heartbeat** | **datetime** |  | 
-**authentication_hash** | **str** |  | 
-**runtime_type_id** | **int** |  | 
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-