temporalio.workflow.ChildWorkflowHandle

class documentation

class ChildWorkflowHandle(_AsyncioTask[ReturnType], Generic[SelfType, ReturnType]): (source)

Known subclasses: temporalio.worker._workflow_instance._ChildWorkflowHandle

View In Hierarchy

Handle for interacting with a child workflow.

This is created via start_child_workflow.

This extends asyncio.Task and supports all task features.

Async Method signal Signal this child workflow.
Property first_execution_run_id Run ID for the workflow.
Property id ID for the workflow.
@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: Callable[Concatenate[SelfType, MultiParamSpec], Union[Awaitable[None], None]], *, args: Sequence[Any]):
@overload
async def signal(self, signal: str, arg: Any = temporalio.common._arg_unset, *, args: Sequence[Any] = []):
(source)
overridden in temporalio.worker._workflow_instance._ChildWorkflowHandle

Signal this child 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
first_execution_run_id: Optional[str] = (source)
overridden in temporalio.worker._workflow_instance._ChildWorkflowHandle

Run ID for the workflow.

@property
id: str = (source)
overridden in temporalio.worker._workflow_instance._ChildWorkflowHandle

ID for the workflow.