temporalio.worker._workflow_instance._ExternalWorkflowHandle

class documentation

class _ExternalWorkflowHandle(temporalio.workflow.ExternalWorkflowHandle[Any]): (source)

Constructor: _ExternalWorkflowHandle(instance, id, run_id)

View In Hierarchy

Undocumented

Method __init__ Undocumented
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.
Instance Variable _id Undocumented
Instance Variable _instance Undocumented
Instance Variable _run_id Undocumented
def __init__(self, instance: _WorkflowInstanceImpl, id: str, run_id: Optional[str]): (source)

Undocumented

async def cancel(self): (source)
overrides temporalio.workflow.ExternalWorkflowHandle.cancel

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

async def signal(self, signal: Union[str, Callable], arg: Any = temporalio.common._arg_unset, *, args: Sequence[Any] = []): (source)
overrides temporalio.workflow.ExternalWorkflowHandle.signal

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)
overrides temporalio.workflow.ExternalWorkflowHandle.id

ID for the workflow.

@property
run_id: Optional[str] = (source)
overrides temporalio.workflow.ExternalWorkflowHandle.run_id

Run ID for the workflow if any.

_id = (source)

Undocumented

_instance = (source)

Undocumented

_run_id = (source)

Undocumented