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

compute_api_client/docs/HTTPNotFoundError.md

@@ -0,0 +1,29 @@
+# HTTPNotFoundError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**detail** | **str** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.http_not_found_error import HTTPNotFoundError
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of HTTPNotFoundError from a JSON string
+http_not_found_error_instance = HTTPNotFoundError.from_json(json)
+# print the JSON string representation of the object
+print(HTTPNotFoundError.to_json())
+
+# convert the object into a dict
+http_not_found_error_dict = http_not_found_error_instance.to_dict()
+# create an instance of HTTPNotFoundError from a dict
+http_not_found_error_from_dict = HTTPNotFoundError.from_dict(http_not_found_error_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/HTTPValidationError.md

@@ -0,0 +1,29 @@
+# HTTPValidationError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**detail** | [**List[ValidationError]**](ValidationError.md) |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.http_validation_error import HTTPValidationError
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of HTTPValidationError from a JSON string
+http_validation_error_instance = HTTPValidationError.from_json(json)
+# print the JSON string representation of the object
+print(HTTPValidationError.to_json())
+
+# convert the object into a dict
+http_validation_error_dict = http_validation_error_instance.to_dict()
+# create an instance of HTTPValidationError from a dict
+http_validation_error_from_dict = HTTPValidationError.from_dict(http_validation_error_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/HealthApi.md

@@ -0,0 +1,72 @@
+# compute_api_client.HealthApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**healthz_healthz_get**](HealthApi.md#healthz_healthz_get) | **GET** /healthz | Report health
+
+
+# **healthz_healthz_get**
+> object healthz_healthz_get()
+
+Report health
+
+Health endpoint.
+
+### Example
+
+
+```python
+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"
+)
+
+
+# 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.HealthApi(api_client)
+
+    try:
+        # Report health
+        api_response = await api_instance.healthz_healthz_get()
+        print("The response of HealthApi->healthz_healthz_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling HealthApi->healthz_healthz_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**object**
+
+### Authorization
+
+No authorization required
+
+### 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/Job.md

@@ -0,0 +1,42 @@
+# Job
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | The ID of the job | 
+**created_on** | **datetime** | Time of creation of the Job | 
+**file_id** | **int** | The ID of the file | 
+**algorithm_type** | [**AlgorithmType**](AlgorithmType.md) | The type of the algorithm | 
+**status** | [**JobStatus**](JobStatus.md) | The status of the Job | 
+**batch_job_id** | **int** | The ID of the batch job | 
+**queued_at** | **datetime** |  | 
+**finished_at** | **datetime** |  | 
+**number_of_shots** | **int** |  | 
+**raw_data_enabled** | **bool** | If raw data is to be attached to results | 
+**session_id** | **str** | The uuid assigned to the job | 
+**trace_id** | **str** | The uuid of the trace in case of job failure | 
+**message** | **str** | The message associated with the executed job if it failed | 
+**source** | **str** | The source application of an exception that caused a job to fail (if applicable). | [optional] [default to '']
+
+## Example
+
+```python
+from compute_api_client.models.job import Job
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Job from a JSON string
+job_instance = Job.from_json(json)
+# print the JSON string representation of the object
+print(Job.to_json())
+
+# convert the object into a dict
+job_dict = job_instance.to_dict()
+# create an instance of Job from a dict
+job_from_dict = Job.from_dict(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/JobIn.md

@@ -0,0 +1,32 @@
+# JobIn
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file_id** | **int** | The ID of the file | 
+**batch_job_id** | **int** | The ID of the batch job | 
+**number_of_shots** | **int** |  | [optional] 
+**raw_data_enabled** | **bool** | If raw data is to be attached to results | [optional] [default to False]
+
+## Example
+
+```python
+from compute_api_client.models.job_in import JobIn
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of JobIn from a JSON string
+job_in_instance = JobIn.from_json(json)
+# print the JSON string representation of the object
+print(JobIn.to_json())
+
+# convert the object into a dict
+job_in_dict = job_in_instance.to_dict()
+# create an instance of JobIn from a dict
+job_in_from_dict = JobIn.from_dict(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/JobPatch.md

@@ -0,0 +1,34 @@
+# JobPatch
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**JobStatus**](JobStatus.md) | The status of the Job | 
+**session_id** | **str** | The uuid assigned to the job | [optional] [default to '']
+**trace_id** | **str** | The uuid of the trace in case of job failure | [optional] [default to '']
+**message** | **str** | The message associated with the executed job if it failed | [optional] [default to '']
+**source** | **str** | The source application of an exception that caused a job to fail (if applicable). | [optional] [default to '']
+**traceback** | **str** | The traceback of the exception | [optional] [default to '']
+
+## Example
+
+```python
+from compute_api_client.models.job_patch import JobPatch
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of JobPatch from a JSON string
+job_patch_instance = JobPatch.from_json(json)
+# print the JSON string representation of the object
+print(JobPatch.to_json())
+
+# convert the object into a dict
+job_patch_dict = job_patch_instance.to_dict()
+# create an instance of JobPatch from a dict
+job_patch_from_dict = JobPatch.from_dict(job_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/JobStatus.md

@@ -0,0 +1,18 @@
+# JobStatus
+
+
+## Enum
+
+* `PLANNED` (value: `'planned'`)
+
+* `RUNNING` (value: `'running'`)
+
+* `COMPLETED` (value: `'completed'`)
+
+* `CANCELLED` (value: `'cancelled'`)
+
+* `FAILED` (value: `'failed'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+