class documentation
class ExternalWorkflowHandle(Generic[
Known subclasses: temporalio.worker._workflow_instance._ExternalWorkflowHandle
Handle for interacting with an external workflow.
This is created via get_external_workflow_handle or
get_external_workflow_handle_for.
| Async Method | cancel |
Send a cancellation request to this external workflow. |
| Async Method | signal |
Signal this external workflow. |
| Property | id |
ID for the workflow. |
| Property | run |
Run ID for the workflow if any. |
async def cancel(self, *, reason:
str = '', event_groups: Sequence[ = None):
(source)
¶
Send a cancellation request to this external workflow.
This will fail if the workflow cannot accept the request (e.g. if the workflow is not found).
| Parameters | |
reason:str | Reason recorded with the cancellation request. Available in
the target workflow via cancellation_reason. |
eventSequence[ | Event Groups to associate this command with, in addition to any from the current Event Group scope. |
async def signal(self, signal:
MethodSyncOrAsyncNoParam[, *, event_groups: Sequence[ = None):async def signal(self, signal:
MethodSyncOrAsyncSingleParam[, arg: ParamType, *, event_groups: Sequence[ = None):async def signal(self, signal:
str, arg: Any = temporalio.common._arg_unset, *, args: Sequence[ = [], event_groups: Sequence[ = None):Signal this external workflow.
| Parameters | |
signal:str | Callable | Name or method reference for the signal. |
arg:Any | Single argument to the signal. |
args:Sequence[ | Multiple arguments to the signal. Cannot be set if arg is. |
eventSequence[ | Event Groups to associate this command with, in addition to any from the current Event Group scope. |