perceptic-core-client 0.6.0__py3-none-any.whl → 0.6.1__py3-none-any.whl

perceptic_core_client/perceptic_core_client/docs/WorkerResourceApi.md

@@ -0,0 +1,427 @@
+# perceptic_core_client.WorkerResourceApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**api_v1_workers_get**](WorkerResourceApi.md#api_v1_workers_get) | **GET** /api/v1/workers | Get Workers
+[**api_v1_workers_worker_id_get**](WorkerResourceApi.md#api_v1_workers_worker_id_get) | **GET** /api/v1/workers/{workerId} | Get Worker Metadata
+[**api_v1_workers_worker_id_runs_post**](WorkerResourceApi.md#api_v1_workers_worker_id_runs_post) | **POST** /api/v1/workers/{workerId}/runs | Post Worker Run
+[**api_v1_workers_worker_id_runs_run_rid_events_get**](WorkerResourceApi.md#api_v1_workers_worker_id_runs_run_rid_events_get) | **GET** /api/v1/workers/{workerId}/runs/{runRid}/events | Get Worker Run Events
+[**api_v1_workers_worker_id_runs_run_rid_resume_post**](WorkerResourceApi.md#api_v1_workers_worker_id_runs_run_rid_resume_post) | **POST** /api/v1/workers/{workerId}/runs/{runRid}/resume | Post Resume Run
+[**api_v1_workers_worker_id_runs_run_rid_status_get**](WorkerResourceApi.md#api_v1_workers_worker_id_runs_run_rid_status_get) | **GET** /api/v1/workers/{workerId}/runs/{runRid}/status | Get Worker Run Status
+
+
+# **api_v1_workers_get**
+> GetWorkersResponse api_v1_workers_get()
+
+Get Workers
+
+### Example
+
+
+```python
+import perceptic_core_client
+from perceptic_core_client.models.get_workers_response import GetWorkersResponse
+from perceptic_core_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 = perceptic_core_client.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with perceptic_core_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = perceptic_core_client.WorkerResourceApi(api_client)
+
+    try:
+        # Get Workers
+        api_response = api_instance.api_v1_workers_get()
+        print("The response of WorkerResourceApi->api_v1_workers_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkerResourceApi->api_v1_workers_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetWorkersResponse**](GetWorkersResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+
+[[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)
+
+# **api_v1_workers_worker_id_get**
+> GetWorkerMetadataResponse api_v1_workers_worker_id_get(worker_id, version=version)
+
+Get Worker Metadata
+
+### Example
+
+
+```python
+import perceptic_core_client
+from perceptic_core_client.models.get_worker_metadata_response import GetWorkerMetadataResponse
+from perceptic_core_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 = perceptic_core_client.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with perceptic_core_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = perceptic_core_client.WorkerResourceApi(api_client)
+    worker_id = 'worker_id_example' # str | 
+    version = 'version_example' # str |  (optional)
+
+    try:
+        # Get Worker Metadata
+        api_response = api_instance.api_v1_workers_worker_id_get(worker_id, version=version)
+        print("The response of WorkerResourceApi->api_v1_workers_worker_id_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkerResourceApi->api_v1_workers_worker_id_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **worker_id** | **str**|  | 
+ **version** | **str**|  | [optional] 
+
+### Return type
+
+[**GetWorkerMetadataResponse**](GetWorkerMetadataResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+
+[[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)
+
+# **api_v1_workers_worker_id_runs_post**
+> PostWorkerRunResponse api_v1_workers_worker_id_runs_post(worker_id, post_worker_run_request, version=version)
+
+Post Worker Run
+
+### Example
+
+
+```python
+import perceptic_core_client
+from perceptic_core_client.models.post_worker_run_request import PostWorkerRunRequest
+from perceptic_core_client.models.post_worker_run_response import PostWorkerRunResponse
+from perceptic_core_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 = perceptic_core_client.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with perceptic_core_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = perceptic_core_client.WorkerResourceApi(api_client)
+    worker_id = 'worker_id_example' # str | 
+    post_worker_run_request = perceptic_core_client.PostWorkerRunRequest() # PostWorkerRunRequest | 
+    version = 'version_example' # str |  (optional)
+
+    try:
+        # Post Worker Run
+        api_response = api_instance.api_v1_workers_worker_id_runs_post(worker_id, post_worker_run_request, version=version)
+        print("The response of WorkerResourceApi->api_v1_workers_worker_id_runs_post:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkerResourceApi->api_v1_workers_worker_id_runs_post: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **worker_id** | **str**|  | 
+ **post_worker_run_request** | [**PostWorkerRunRequest**](PostWorkerRunRequest.md)|  | 
+ **version** | **str**|  | [optional] 
+
+### Return type
+
+[**PostWorkerRunResponse**](PostWorkerRunResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+**400** | Bad Request |  -  |
+
+[[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)
+
+# **api_v1_workers_worker_id_runs_run_rid_events_get**
+> GetWorkerEventsResponse api_v1_workers_worker_id_runs_run_rid_events_get(run_rid, worker_id, limit=limit, offset=offset)
+
+Get Worker Run Events
+
+### Example
+
+
+```python
+import perceptic_core_client
+from perceptic_core_client.models.get_worker_events_response import GetWorkerEventsResponse
+from perceptic_core_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 = perceptic_core_client.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with perceptic_core_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = perceptic_core_client.WorkerResourceApi(api_client)
+    run_rid = 'run_rid_example' # str | 
+    worker_id = 'worker_id_example' # str | 
+    limit = 50 # int |  (optional) (default to 50)
+    offset = 0 # int |  (optional) (default to 0)
+
+    try:
+        # Get Worker Run Events
+        api_response = api_instance.api_v1_workers_worker_id_runs_run_rid_events_get(run_rid, worker_id, limit=limit, offset=offset)
+        print("The response of WorkerResourceApi->api_v1_workers_worker_id_runs_run_rid_events_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkerResourceApi->api_v1_workers_worker_id_runs_run_rid_events_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **run_rid** | **str**|  | 
+ **worker_id** | **str**|  | 
+ **limit** | **int**|  | [optional] [default to 50]
+ **offset** | **int**|  | [optional] [default to 0]
+
+### Return type
+
+[**GetWorkerEventsResponse**](GetWorkerEventsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+
+[[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)
+
+# **api_v1_workers_worker_id_runs_run_rid_resume_post**
+> object api_v1_workers_worker_id_runs_run_rid_resume_post(run_rid, worker_id, post_worker_run_request)
+
+Post Resume Run
+
+### Example
+
+
+```python
+import perceptic_core_client
+from perceptic_core_client.models.post_worker_run_request import PostWorkerRunRequest
+from perceptic_core_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 = perceptic_core_client.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with perceptic_core_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = perceptic_core_client.WorkerResourceApi(api_client)
+    run_rid = 'run_rid_example' # str | 
+    worker_id = 'worker_id_example' # str | 
+    post_worker_run_request = perceptic_core_client.PostWorkerRunRequest() # PostWorkerRunRequest | 
+
+    try:
+        # Post Resume Run
+        api_response = api_instance.api_v1_workers_worker_id_runs_run_rid_resume_post(run_rid, worker_id, post_worker_run_request)
+        print("The response of WorkerResourceApi->api_v1_workers_worker_id_runs_run_rid_resume_post:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkerResourceApi->api_v1_workers_worker_id_runs_run_rid_resume_post: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **run_rid** | **str**|  | 
+ **worker_id** | **str**|  | 
+ **post_worker_run_request** | [**PostWorkerRunRequest**](PostWorkerRunRequest.md)|  | 
+
+### Return type
+
+**object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+**400** | Bad Request |  -  |
+
+[[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)
+
+# **api_v1_workers_worker_id_runs_run_rid_status_get**
+> GetWorkerStatusResponse api_v1_workers_worker_id_runs_run_rid_status_get(run_rid, worker_id)
+
+Get Worker Run Status
+
+### Example
+
+
+```python
+import perceptic_core_client
+from perceptic_core_client.models.get_worker_status_response import GetWorkerStatusResponse
+from perceptic_core_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 = perceptic_core_client.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with perceptic_core_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = perceptic_core_client.WorkerResourceApi(api_client)
+    run_rid = 'run_rid_example' # str | 
+    worker_id = 'worker_id_example' # str | 
+
+    try:
+        # Get Worker Run Status
+        api_response = api_instance.api_v1_workers_worker_id_runs_run_rid_status_get(run_rid, worker_id)
+        print("The response of WorkerResourceApi->api_v1_workers_worker_id_runs_run_rid_status_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkerResourceApi->api_v1_workers_worker_id_runs_run_rid_status_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **run_rid** | **str**|  | 
+ **worker_id** | **str**|  | 
+
+### Return type
+
+[**GetWorkerStatusResponse**](GetWorkerStatusResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+
+[[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)
+

perceptic_core_client/perceptic_core_client/exceptions.py

@@ -0,0 +1,216 @@
+# coding: utf-8
+
+"""
+    perceptic-core-server API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.0.1-SNAPSHOT
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from typing import Any, Optional
+from typing_extensions import Self
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None,
+                 key_type=None) -> None:
+        """ Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+
+    def __init__(
+        self, 
+        status=None, 
+        reason=None, 
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode('utf-8')
+                except Exception:
+                    pass
+            self.headers = http_resp.getheaders()
+
+    @classmethod
+    def from_response(
+        cls, 
+        *, 
+        http_resp, 
+        body: Optional[str], 
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n"\
+                        "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(
+                self.headers)
+
+        if self.data or self.body:
+            error_message += "HTTP response body: {0}\n".format(self.data or self.body)
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+    pass
+
+
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result