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

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)
-
-

compute_api_client/models/batch_run.py

@@ -1,423 +0,0 @@
-# coding: utf-8
-
-"""
-    Compute Job Manager
-
-    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
-"""
-
-
-try:
-    from inspect import getfullargspec
-except ImportError:
-    from inspect import getargspec as getfullargspec
-import pprint
-import re  # noqa: F401
-import six
-
-from compute_api_client.configuration import Configuration
-
-
-class BatchRun(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
-    """
-
-    """
-    Attributes:
-      openapi_types (dict): The key is attribute name
-                            and the value is attribute type.
-      attribute_map (dict): The key is attribute name
-                            and the value is json key in definition.
-    """
-    openapi_types = {
-        'created_on': 'datetime',
-        'queued_at': 'datetime',
-        'finished_at': 'datetime',
-        'id': 'int',
-        'status': 'BatchRunStatus',
-        'reserved_at': 'datetime',
-        'runtime_id': 'int',
-        'runtime_type_id': 'int',
-        'user_id': 'int',
-        'run_ids': 'list[int]',
-        'aggregated_algorithm_type': 'AlgorithmType'
-    }
-
-    attribute_map = {
-        'created_on': 'created_on',
-        'queued_at': 'queued_at',
-        'finished_at': 'finished_at',
-        'id': 'id',
-        'status': 'status',
-        'reserved_at': 'reserved_at',
-        'runtime_id': 'runtime_id',
-        'runtime_type_id': 'runtime_type_id',
-        'user_id': 'user_id',
-        'run_ids': 'run_ids',
-        'aggregated_algorithm_type': 'aggregated_algorithm_type'
-    }
-
-    def __init__(self, created_on=None, queued_at=None, finished_at=None, id=None, status=None, reserved_at=None, runtime_id=None, runtime_type_id=None, user_id=None, run_ids=None, aggregated_algorithm_type=None, local_vars_configuration=None):  # noqa: E501
-        """BatchRun - a model defined in OpenAPI"""  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._created_on = None
-        self._queued_at = None
-        self._finished_at = None
-        self._id = None
-        self._status = None
-        self._reserved_at = None
-        self._runtime_id = None
-        self._runtime_type_id = None
-        self._user_id = None
-        self._run_ids = None
-        self._aggregated_algorithm_type = None
-        self.discriminator = None
-
-        self.created_on = created_on
-        self.queued_at = queued_at
-        self.finished_at = finished_at
-        self.id = id
-        self.status = status
-        self.reserved_at = reserved_at
-        self.runtime_id = runtime_id
-        self.runtime_type_id = runtime_type_id
-        self.user_id = user_id
-        self.run_ids = run_ids
-        self.aggregated_algorithm_type = aggregated_algorithm_type
-
-    @property
-    def created_on(self):
-        """Gets the created_on of this BatchRun.  # noqa: E501
-
-
-        :return: The created_on of this BatchRun.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._created_on
-
-    @created_on.setter
-    def created_on(self, created_on):
-        """Sets the created_on of this BatchRun.
-
-
-        :param created_on: The created_on of this BatchRun.  # noqa: E501
-        :type created_on: datetime
-        """
-        if self.local_vars_configuration.client_side_validation and created_on is None:  # noqa: E501
-            raise ValueError("Invalid value for `created_on`, must not be `None`")  # noqa: E501
-
-        self._created_on = created_on
-
-    @property
-    def queued_at(self):
-        """Gets the queued_at of this BatchRun.  # noqa: E501
-
-
-        :return: The queued_at of this BatchRun.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._queued_at
-
-    @queued_at.setter
-    def queued_at(self, queued_at):
-        """Sets the queued_at of this BatchRun.
-
-
-        :param queued_at: The queued_at of this BatchRun.  # noqa: E501
-        :type queued_at: datetime
-        """
-
-        self._queued_at = queued_at
-
-    @property
-    def finished_at(self):
-        """Gets the finished_at of this BatchRun.  # noqa: E501
-
-
-        :return: The finished_at of this BatchRun.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._finished_at
-
-    @finished_at.setter
-    def finished_at(self, finished_at):
-        """Sets the finished_at of this BatchRun.
-
-
-        :param finished_at: The finished_at of this BatchRun.  # noqa: E501
-        :type finished_at: datetime
-        """
-
-        self._finished_at = finished_at
-
-    @property
-    def id(self):
-        """Gets the id of this BatchRun.  # noqa: E501
-
-
-        :return: The id of this BatchRun.  # noqa: E501
-        :rtype: int
-        """
-        return self._id
-
-    @id.setter
-    def id(self, id):
-        """Sets the id of this BatchRun.
-
-
-        :param id: The id of this BatchRun.  # noqa: E501
-        :type id: int
-        """
-        if self.local_vars_configuration.client_side_validation and id is None:  # noqa: E501
-            raise ValueError("Invalid value for `id`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                id is not None and id > 2147483647):  # noqa: E501
-            raise ValueError("Invalid value for `id`, must be a value less than or equal to `2147483647`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                id is not None and id < 1):  # noqa: E501
-            raise ValueError("Invalid value for `id`, must be a value greater than or equal to `1`")  # noqa: E501
-
-        self._id = id
-
-    @property
-    def status(self):
-        """Gets the status of this BatchRun.  # noqa: E501
-
-        PLANNED: planned<br/>QUEUED: queued<br/>RESERVED: reserved<br/>RUNNING: running<br/>FINISHED: finished  # noqa: E501
-
-        :return: The status of this BatchRun.  # noqa: E501
-        :rtype: BatchRunStatus
-        """
-        return self._status
-
-    @status.setter
-    def status(self, status):
-        """Sets the status of this BatchRun.
-
-        PLANNED: planned<br/>QUEUED: queued<br/>RESERVED: reserved<br/>RUNNING: running<br/>FINISHED: finished  # noqa: E501
-
-        :param status: The status of this BatchRun.  # noqa: E501
-        :type status: BatchRunStatus
-        """
-        if self.local_vars_configuration.client_side_validation and status is None:  # noqa: E501
-            raise ValueError("Invalid value for `status`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                status is not None and len(status) > 8):
-            raise ValueError("Invalid value for `status`, length must be less than or equal to `8`")  # noqa: E501
-
-        self._status = status
-
-    @property
-    def reserved_at(self):
-        """Gets the reserved_at of this BatchRun.  # noqa: E501
-
-
-        :return: The reserved_at of this BatchRun.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._reserved_at
-
-    @reserved_at.setter
-    def reserved_at(self, reserved_at):
-        """Sets the reserved_at of this BatchRun.
-
-
-        :param reserved_at: The reserved_at of this BatchRun.  # noqa: E501
-        :type reserved_at: datetime
-        """
-
-        self._reserved_at = reserved_at
-
-    @property
-    def runtime_id(self):
-        """Gets the runtime_id of this BatchRun.  # noqa: E501
-
-
-        :return: The runtime_id of this BatchRun.  # noqa: E501
-        :rtype: int
-        """
-        return self._runtime_id
-
-    @runtime_id.setter
-    def runtime_id(self, runtime_id):
-        """Sets the runtime_id of this BatchRun.
-
-
-        :param runtime_id: The runtime_id of this BatchRun.  # noqa: E501
-        :type runtime_id: int
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                runtime_id is not None and runtime_id > 2147483647):  # noqa: E501
-            raise ValueError("Invalid value for `runtime_id`, must be a value less than or equal to `2147483647`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                runtime_id is not None and runtime_id < 1):  # noqa: E501
-            raise ValueError("Invalid value for `runtime_id`, must be a value greater than or equal to `1`")  # noqa: E501
-
-        self._runtime_id = runtime_id
-
-    @property
-    def runtime_type_id(self):
-        """Gets the runtime_type_id of this BatchRun.  # noqa: E501
-
-
-        :return: The runtime_type_id of this BatchRun.  # noqa: E501
-        :rtype: int
-        """
-        return self._runtime_type_id
-
-    @runtime_type_id.setter
-    def runtime_type_id(self, runtime_type_id):
-        """Sets the runtime_type_id of this BatchRun.
-
-
-        :param runtime_type_id: The runtime_type_id of this BatchRun.  # noqa: E501
-        :type runtime_type_id: int
-        """
-        if self.local_vars_configuration.client_side_validation and runtime_type_id is None:  # noqa: E501
-            raise ValueError("Invalid value for `runtime_type_id`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                runtime_type_id is not None and runtime_type_id > 2147483647):  # noqa: E501
-            raise ValueError("Invalid value for `runtime_type_id`, must be a value less than or equal to `2147483647`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                runtime_type_id is not None and runtime_type_id < 1):  # noqa: E501
-            raise ValueError("Invalid value for `runtime_type_id`, must be a value greater than or equal to `1`")  # noqa: E501
-
-        self._runtime_type_id = runtime_type_id
-
-    @property
-    def user_id(self):
-        """Gets the user_id of this BatchRun.  # noqa: E501
-
-
-        :return: The user_id of this BatchRun.  # noqa: E501
-        :rtype: int
-        """
-        return self._user_id
-
-    @user_id.setter
-    def user_id(self, user_id):
-        """Sets the user_id of this BatchRun.
-
-
-        :param user_id: The user_id of this BatchRun.  # noqa: E501
-        :type user_id: int
-        """
-        if self.local_vars_configuration.client_side_validation and user_id is None:  # noqa: E501
-            raise ValueError("Invalid value for `user_id`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                user_id is not None and user_id > 2147483647):  # noqa: E501
-            raise ValueError("Invalid value for `user_id`, must be a value less than or equal to `2147483647`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                user_id is not None and user_id < 1):  # noqa: E501
-            raise ValueError("Invalid value for `user_id`, must be a value greater than or equal to `1`")  # noqa: E501
-
-        self._user_id = user_id
-
-    @property
-    def run_ids(self):
-        """Gets the run_ids of this BatchRun.  # noqa: E501
-
-
-        :return: The run_ids of this BatchRun.  # noqa: E501
-        :rtype: list[int]
-        """
-        return self._run_ids
-
-    @run_ids.setter
-    def run_ids(self, run_ids):
-        """Sets the run_ids of this BatchRun.
-
-
-        :param run_ids: The run_ids of this BatchRun.  # noqa: E501
-        :type run_ids: list[int]
-        """
-        if self.local_vars_configuration.client_side_validation and run_ids is None:  # noqa: E501
-            raise ValueError("Invalid value for `run_ids`, must not be `None`")  # noqa: E501
-
-        self._run_ids = run_ids
-
-    @property
-    def aggregated_algorithm_type(self):
-        """Gets the aggregated_algorithm_type of this BatchRun.  # noqa: E501
-
-
-        :return: The aggregated_algorithm_type of this BatchRun.  # noqa: E501
-        :rtype: AlgorithmType
-        """
-        return self._aggregated_algorithm_type
-
-    @aggregated_algorithm_type.setter
-    def aggregated_algorithm_type(self, aggregated_algorithm_type):
-        """Sets the aggregated_algorithm_type of this BatchRun.
-
-
-        :param aggregated_algorithm_type: The aggregated_algorithm_type of this BatchRun.  # noqa: E501
-        :type aggregated_algorithm_type: AlgorithmType
-        """
-        if self.local_vars_configuration.client_side_validation and aggregated_algorithm_type is None:  # noqa: E501
-            raise ValueError("Invalid value for `aggregated_algorithm_type`, must not be `None`")  # noqa: E501
-
-        self._aggregated_algorithm_type = aggregated_algorithm_type
-
-    def to_dict(self, serialize=False):
-        """Returns the model properties as a dict"""
-        result = {}
-
-        def convert(x):
-            if hasattr(x, "to_dict"):
-                args = getfullargspec(x.to_dict).args
-                if len(args) == 1:
-                    return x.to_dict()
-                else:
-                    return x.to_dict(serialize)
-            else:
-                return x
-
-        for attr, _ in six.iteritems(self.openapi_types):
-            value = getattr(self, attr)
-            attr = self.attribute_map.get(attr, attr) if serialize else attr
-            if isinstance(value, list):
-                result[attr] = list(map(
-                    lambda x: convert(x),
-                    value
-                ))
-            elif isinstance(value, dict):
-                result[attr] = dict(map(
-                    lambda item: (item[0], convert(item[1])),
-                    value.items()
-                ))
-            else:
-                result[attr] = convert(value)
-
-        return result
-
-    def to_str(self):
-        """Returns the string representation of the model"""
-        return pprint.pformat(self.to_dict())
-
-    def __repr__(self):
-        """For `print` and `pprint`"""
-        return self.to_str()
-
-    def __eq__(self, other):
-        """Returns true if both objects are equal"""
-        if not isinstance(other, BatchRun):
-            return False
-
-        return self.to_dict() == other.to_dict()
-
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, BatchRun):
-            return True
-
-        return self.to_dict() != other.to_dict()