temporalio.workflow._workflow_ops.ChildWorkflowHandle

class documentation

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

Known subclasses: temporalio.worker._workflow_instance._ChildWorkflowHandle

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], *, event_groups: Sequence[EventGroup] | None = None):

@overload

async def signal(self, signal: MethodSyncOrAsyncSingleParam[SelfType, ParamType, None], arg: ParamType, *, event_groups: Sequence[EventGroup] | None = None):

@overload

async def signal(self, signal: Callable[Concatenate[SelfType, MultiParamSpec], Awaitable[None] | None], *, args: Sequence[Any], event_groups: Sequence[EventGroup] | None = None):

@overload

async def signal(self, signal: str, arg: Any = temporalio.common._arg_unset, *, args: Sequence[Any] = [], event_groups: Sequence[EventGroup] | None = None):

(source) ¶

overridden in temporalio.worker._workflow_instance._ChildWorkflowHandle

Signal this child workflow.

Parameters
signal:`str \| Callable`	Name or method reference for the signal.
arg:`Any`	Single argument to the signal.
args:`Sequence[Any]`	Multiple arguments to the signal. Cannot be set if arg is.
event_groups:`Sequence[EventGroup] \| None`	Event Groups to associate this command with, in addition to any from the current Event Group scope.

@property

first_execution_run_id: str | None = (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.