- Overview
- dispatch_mesh_task
dispatch_mesh_task
Part of Reusable workflows in the Python API reference.
Related guidance: shipped-tooling.
Runnable examples: dispatch_mesh_task.py.
from picogrid_ecn_client.workflows import dispatch_mesh_taskDispatch one typed echo request on an explicit terminal-addressed route.
async def dispatch_mesh_task( client: ECNClient, *, target_entity_id: UUID, target_integration: str, target_terminal_id: UUID, command: str, message: str, timeout: float | None = None, mode: TaskMode = TaskMode.COMPLETE,) -> DispatchTaskResultParameters
Section titled “Parameters”| Name | Type | Default | Description |
|---|---|---|---|
| client | ECNClient | — | Configured SDK client used to dispatch the request. |
| target_entity_id | UUID | — | Canonical identity of the task target. |
| target_integration | str | — | Exact integration name that owns the target. |
| target_terminal_id | UUID | — | Canonical terminal identity that routes to the target. |
| command | str | — | Exact command name to invoke. |
| message | str | — | Echo message sent in the typed request body. |
| timeout | float | None | None | Optional maximum wait in seconds. |
| mode | TaskMode | TaskMode.COMPLETE | Requested task completion mode. |
Returns
Section titled “Returns”| Type | Description |
|---|---|
| DispatchTaskResult | The public dispatch receipt or completed task result. |
Raises
Section titled “Raises”| Exception | Description |
|---|---|
| ECNClientError | If validation, dispatch, or response handling fails. |
Version 0.2.0 · branch main
