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

compute_api_client/docs/{RuntimeTypesApi.md → BackendTypesApi.md}

@@ -1,29 +1,31 @@
-# compute_api_client.RuntimeTypesApi
+# compute_api_client.BackendTypesApi
 
 All URIs are relative to *http://localhost*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**read_runtime_type_runtime_types_id_get**](RuntimeTypesApi.md#read_runtime_type_runtime_types_id_get) | **GET** /runtime_types/{id} | Retrieve runtime type
-[**read_runtime_types_runtime_types_get**](RuntimeTypesApi.md#read_runtime_types_runtime_types_get) | **GET** /runtime_types/ | List runtime types
+[**read_backend_type_backend_types_id_get**](BackendTypesApi.md#read_backend_type_backend_types_id_get) | **GET** /backend_types/{id} | Retrieve backend type
+[**read_backend_types_backend_types_get**](BackendTypesApi.md#read_backend_types_backend_types_get) | **GET** /backend_types/ | List backend types
 
 
-# **read_runtime_type_runtime_types_id_get**
-> RuntimeType read_runtime_type_runtime_types_id_get(id)
+# **read_backend_type_backend_types_id_get**
+> BackendType read_backend_type_backend_types_id_get(id)
 
-Retrieve runtime type
+Retrieve backend type
 
-Get runtime type by ID.
+Get backend type by ID.
 
 ### Example
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.backend_type import BackendType
 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(
@@ -36,25 +38,28 @@ configuration = compute_api_client.Configuration(
 # satisfies your auth use case.
 
 # Configure API key authorization: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
+configuration.api_key['user'] = os.environ["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:
+async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
-    api_instance = compute_api_client.RuntimeTypesApi(api_client)
+    api_instance = compute_api_client.BackendTypesApi(api_client)
     id = 56 # int | 
 
     try:
-        # Retrieve runtime type
-        api_response = api_instance.read_runtime_type_runtime_types_id_get(id)
+        # Retrieve backend type
+        api_response = await api_instance.read_backend_type_backend_types_id_get(id)
+        print("The response of BackendTypesApi->read_backend_type_backend_types_id_get:\n")
         pprint(api_response)
-    except ApiException as e:
-        print("Exception when calling RuntimeTypesApi->read_runtime_type_runtime_types_id_get: %s\n" % e)
+    except Exception as e:
+        print("Exception when calling BackendTypesApi->read_backend_type_backend_types_id_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -63,7 +68,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**RuntimeType**](RuntimeType.md)
+[**BackendType**](BackendType.md)
 
 ### Authorization
 
@@ -83,22 +88,24 @@ Name | Type | Description  | Notes
 
 [[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_types_runtime_types_get**
-> list[RuntimeType] read_runtime_types_runtime_types_get()
+# **read_backend_types_backend_types_get**
+> 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)
 
-List runtime types
+List backend types
 
-Read runtime types.
+Read backend types.
 
 ### Example
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.backend_type import BackendType
 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(
@@ -111,30 +118,49 @@ configuration = compute_api_client.Configuration(
 # satisfies your auth use case.
 
 # Configure API key authorization: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
+configuration.api_key['user'] = os.environ["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:
+async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
-    api_instance = compute_api_client.RuntimeTypesApi(api_client)
-    
+    api_instance = compute_api_client.BackendTypesApi(api_client)
+    latest = True # bool |  (optional)
+    id = 56 # int |  (optional)
+    name = 'name_example' # str |  (optional)
+    infrastructure = 'infrastructure_example' # str |  (optional)
+    description = 'description_example' # str |  (optional)
+    image_id = 'image_id_example' # str |  (optional)
+    is_hardware = True # bool |  (optional)
+
     try:
-        # List runtime types
-        api_response = api_instance.read_runtime_types_runtime_types_get()
+        # List backend types
+        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)
+        print("The response of BackendTypesApi->read_backend_types_backend_types_get:\n")
         pprint(api_response)
-    except ApiException as e:
-        print("Exception when calling RuntimeTypesApi->read_runtime_types_runtime_types_get: %s\n" % e)
+    except Exception as e:
+        print("Exception when calling BackendTypesApi->read_backend_types_backend_types_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **latest** | **bool**|  | [optional] 
+ **id** | **int**|  | [optional] 
+ **name** | **str**|  | [optional] 
+ **infrastructure** | **str**|  | [optional] 
+ **description** | **str**|  | [optional] 
+ **image_id** | **str**|  | [optional] 
+ **is_hardware** | **bool**|  | [optional] 
 
 ### Return type
 
-[**list[RuntimeType]**](RuntimeType.md)
+[**List[BackendType]**](BackendType.md)
 
 ### Authorization
 
@@ -149,6 +175,7 @@ This endpoint does not need any parameter.
 | 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/BackendWithAuthentication.md

@@ -0,0 +1,34 @@
+# BackendWithAuthentication
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** |  | 
+**name** | **str** |  | 
+**location** | **str** |  | 
+**backend_type_id** | **int** |  | 
+**status** | [**BackendStatus**](BackendStatus.md) |  | 
+**last_heartbeat** | **datetime** |  | 
+**authentication_hash** | **str** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.backend_with_authentication import BackendWithAuthentication
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BackendWithAuthentication from a JSON string
+backend_with_authentication_instance = BackendWithAuthentication.from_json(json)
+# print the JSON string representation of the object
+print BackendWithAuthentication.to_json()
+
+# convert the object into a dict
+backend_with_authentication_dict = backend_with_authentication_instance.to_dict()
+# create an instance of BackendWithAuthentication from a dict
+backend_with_authentication_form_dict = backend_with_authentication.from_dict(backend_with_authentication_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/BatchJob.md

@@ -0,0 +1,38 @@
+# BatchJob
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** |  | 
+**created_on** | **datetime** |  | 
+**status** | [**BatchJobStatus**](BatchJobStatus.md) |  | 
+**user_id** | **int** |  | 
+**backend_type_id** | **int** |  | 
+**backend_id** | **int** |  | 
+**queued_at** | **datetime** |  | 
+**reserved_at** | **datetime** |  | 
+**finished_at** | **datetime** |  | 
+**job_ids** | **List[int]** |  | 
+**aggregated_algorithm_type** | [**AlgorithmType**](AlgorithmType.md) |  | 
+
+## Example
+
+```python
+from compute_api_client.models.batch_job import BatchJob
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BatchJob from a JSON string
+batch_job_instance = BatchJob.from_json(json)
+# print the JSON string representation of the object
+print BatchJob.to_json()
+
+# convert the object into a dict
+batch_job_dict = batch_job_instance.to_dict()
+# create an instance of BatchJob from a dict
+batch_job_form_dict = batch_job.from_dict(batch_job_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/BatchJobIn.md

@@ -0,0 +1,29 @@
+# BatchJobIn
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **int** |  | 
+**backend_type_id** | **int** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.batch_job_in import BatchJobIn
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BatchJobIn from a JSON string
+batch_job_in_instance = BatchJobIn.from_json(json)
+# print the JSON string representation of the object
+print BatchJobIn.to_json()
+
+# convert the object into a dict
+batch_job_in_dict = batch_job_in_instance.to_dict()
+# create an instance of BatchJobIn from a dict
+batch_job_in_form_dict = batch_job_in.from_dict(batch_job_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/{RuntimeStatus.md → BatchJobStatus.md}

@@ -1,6 +1,5 @@
-# RuntimeStatus
+# BatchJobStatus
 
-An enumeration.
 
 ## Properties
 Name | Type | Description | Notes