temporalio.workflow.ExternalWorkflowHandle

class documentation

class ExternalWorkflowHandle(Generic[SelfType]): (source)

Known subclasses: temporalio.worker._workflow_instance._ExternalWorkflowHandle

View In Hierarchy

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_id Run ID for the workflow if any.
async def cancel(self): (source)
overridden in temporalio.worker._workflow_instance._ExternalWorkflowHandle

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).

@overload
async def signal(self, signal: MethodSyncOrAsyncNoParam[SelfType, None]):
@overload
async def signal(self, signal: MethodSyncOrAsyncSingleParam[SelfType, ParamType, None], arg: ParamType):
@overload
async def signal(self, signal: str, arg: Any = temporalio.common._arg_unset, *, args: Sequence[Any] = []):
(source)
overridden in temporalio.worker._workflow_instance._ExternalWorkflowHandle

Signal this external workflow.

Parameters
signal:Union[str, Callable]Name or method reference for the signal.
arg:AnySingle argument to the signal.
args:Sequence[Any]Multiple arguments to the signal. Cannot be set if arg is.
@property
id: str = (source)
overridden in temporalio.worker._workflow_instance._ExternalWorkflowHandle

ID for the workflow.

@property
run_id: Optional[str] = (source)
overridden in temporalio.worker._workflow_instance._ExternalWorkflowHandle

Run ID for the workflow if any.