xCherry APIs
Project description
xcherryapi
This APIs between xCherry service and SDKs
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 0.0.1
- Package version: 0.0.1
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.7+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/xcherryio/apis.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/xcherryio/apis.git
)
Then import the package:
import xcherryapi
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import xcherryapi
Tests
Execute pytest
to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import time
import xcherryapi
from xcherryapi.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 = xcherryapi.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with xcherryapi.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = xcherryapi.DefaultApi(api_client)
process_execution_describe_request = xcherryapi.ProcessExecutionDescribeRequest() # ProcessExecutionDescribeRequest | (optional)
try:
# describe a process execution
api_response = api_instance.api_v1_xcherry_service_process_execution_describe_post(process_execution_describe_request=process_execution_describe_request)
print("The response of DefaultApi->api_v1_xcherry_service_process_execution_describe_post:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->api_v1_xcherry_service_process_execution_describe_post: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | api_v1_xcherry_service_process_execution_describe_post | POST /api/v1/xcherry/service/process-execution/describe | describe a process execution |
DefaultApi | api_v1_xcherry_service_process_execution_publish_to_local_queue_post | POST /api/v1/xcherry/service/process-execution/publish-to-local-queue | send message(s) to be consumed within a single process execution |
DefaultApi | api_v1_xcherry_service_process_execution_rpc_post | POST /api/v1/xcherry/service/process-execution/rpc | execute a RPC method of a process execution |
DefaultApi | api_v1_xcherry_service_process_execution_start_post | POST /api/v1/xcherry/service/process-execution/start | start a process execution |
DefaultApi | api_v1_xcherry_service_process_execution_stop_post | POST /api/v1/xcherry/service/process-execution/stop | stop a process execution |
DefaultApi | api_v1_xcherry_worker_async_state_execute_post | POST /api/v1/xcherry/worker/async-state/execute | invoking AsyncState.execute API |
DefaultApi | api_v1_xcherry_worker_async_state_wait_until_post | POST /api/v1/xcherry/worker/async-state/wait-until | invoking AsyncState.waitUntil API |
DefaultApi | api_v1_xcherry_worker_process_rpc_post | POST /api/v1/xcherry/worker/process/rpc | execute a RPC method of a process execution in the worker |
DefaultApi | internal_api_v1_xcherry_notify_immediate_tasks_post | POST /internal/api/v1/xcherry/notify-immediate-tasks | for api service to tell async service that there are new immediate tasks added to the queue |
DefaultApi | internal_api_v1_xcherry_notify_timer_tasks_post | POST /internal/api/v1/xcherry/notify-timer-tasks | for api service to tell async service that there are new timer tasks added to the queue |
Documentation For Models
- ApiErrorResponse
- AppDatabaseColumnValue
- AppDatabaseConfig
- AppDatabaseError
- AppDatabaseErrorHandling
- AppDatabaseReadRequest
- AppDatabaseReadResponse
- AppDatabaseRowReadResponse
- AppDatabaseRowWrite
- AppDatabaseTableConfig
- AppDatabaseTableReadRequest
- AppDatabaseTableReadResponse
- AppDatabaseTableRowSelector
- AppDatabaseTableWrite
- AppDatabaseWrite
- AsyncStateConfig
- AsyncStateExecuteRequest
- AsyncStateExecuteResponse
- AsyncStateWaitUntilRequest
- AsyncStateWaitUntilResponse
- CommandRequest
- CommandResults
- CommandStatus
- CommandWaitingType
- Context
- DatabaseLockingType
- EncodedObject
- ErrorSubType
- KeyValue
- LoadLocalAttributesRequest
- LoadLocalAttributesResponse
- LocalAttributeConfig
- LocalQueueCommand
- LocalQueueMessage
- LocalQueueMessageResult
- LocalQueueResult
- NotifyImmediateTasksRequest
- NotifyTimerTasksRequest
- ProcessExecutionDescribeRequest
- ProcessExecutionDescribeResponse
- ProcessExecutionRpcRequest
- ProcessExecutionRpcResponse
- ProcessExecutionStartRequest
- ProcessExecutionStartResponse
- ProcessExecutionStopRequest
- ProcessExecutionStopType
- ProcessIdReusePolicy
- ProcessRpcWorkerRequest
- ProcessRpcWorkerResponse
- ProcessStartConfig
- ProcessStatus
- PublishToLocalQueueRequest
- RetryPolicy
- StateDecision
- StateFailureRecoveryOptions
- StateFailureRecoveryPolicy
- StateMovement
- ThreadCloseDecision
- ThreadCloseType
- TimerCommand
- TimerResult
- WorkerApiType
- WorkerErrorResponse
- WriteConflictMode
Documentation For Authorization
Endpoints do not require authorization.
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for xcherryapi-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e074da23a475293909324e46461314b31a1b4801f3dbe1189dd7f35d39b8825 |
|
MD5 | 5030d373b4db610795b8d61b08467633 |
|
BLAKE2b-256 | a7de14ee16f0c2826db7419ab41629efa817e11e36adfbc1281f43f8ae71ae00 |