temporalio.workflow.NexusClient

class documentation

class NexusClient(ABC, Generic[ServiceT]): (source)

Known subclasses: temporalio.workflow._NexusClient

A client for invoking Nexus operations.

Warning

This API is experimental and unstable.

Example:

nexus_client = workflow.create_nexus_client(
    endpoint=my_nexus_endpoint,
    service=MyService,
)
handle = await nexus_client.start_operation(
    operation=MyService.my_operation,
    input=MyOperationInput(value="hello"),
    schedule_to_close_timeout=timedelta(seconds=10),
)
result = await handle.result()

Async Method	`execute_operation`	Execute a Nexus operation and return its result.
Async Method	`start_operation`	Start a Nexus operation and return its handle.

@overload
@abstractmethod

async def execute_operation(self, operation: nexusrpc.Operation[InputT, OutputT], input: InputT, *, output_type: type[OutputT] | None = None, schedule_to_close_timeout: timedelta | None = None, cancellation_type: NexusOperationCancellationType = NexusOperationCancellationType.WAIT_COMPLETED, headers: Mapping[str, str] | None = None) -> OutputT:

@overload
@abstractmethod

async def execute_operation(self, operation: str, input: Any, *, output_type: type[OutputT] | None = None, schedule_to_close_timeout: timedelta | None = None, cancellation_type: NexusOperationCancellationType = NexusOperationCancellationType.WAIT_COMPLETED, headers: Mapping[str, str] | None = None) -> OutputT:

@overload
@abstractmethod

async def execute_operation(self, operation:

Callable[[ServiceHandlerT, temporalio.nexus.WorkflowRunOperationContext, InputT], Awaitable[temporalio.nexus.WorkflowHandle[OutputT]]]

, input: InputT, *, output_type: type[OutputT] | None = None, schedule_to_close_timeout: timedelta | None = None, cancellation_type: NexusOperationCancellationType = NexusOperationCancellationType.WAIT_COMPLETED, headers: Mapping[str, str] | None = None) -> OutputT:

@overload
@abstractmethod

async def execute_operation(self, operation: Callable[[ServiceT, nexusrpc.handler.StartOperationContext, InputT], Awaitable[OutputT]], input: InputT, *, output_type: type[OutputT] | None = None, schedule_to_close_timeout: timedelta | None = None, cancellation_type: NexusOperationCancellationType = NexusOperationCancellationType.WAIT_COMPLETED, headers: Mapping[str, str] | None = None) -> OutputT:

@overload
@abstractmethod

async def execute_operation(self, operation: Callable[[ServiceT, nexusrpc.handler.StartOperationContext, InputT], OutputT], input: InputT, *, output_type: type[OutputT] | None = None, schedule_to_close_timeout: timedelta | None = None, cancellation_type: NexusOperationCancellationType = NexusOperationCancellationType.WAIT_COMPLETED, headers: Mapping[str, str] | None = None) -> OutputT:

@abstractmethod
(source) ¶

overridden in temporalio.workflow._NexusClient

Execute a Nexus operation and return its result.

Parameters
operation:`Any`	The Nexus operation.
input:`Any`	The Nexus operation input.
output_type:`type[OutputT] \| None`	The Nexus operation output type.
schedule_to_close_timeout:`timedelta \| None`	Timeout for the entire operation attempt.
cancellation_type:`NexusOperationCancellationType`	Undocumented
headers:`Mapping[str, str] \| None`	Headers to send with the Nexus HTTP request.
Returns
`Any`	The operation result.

@overload
@abstractmethod

async def start_operation(self, operation: nexusrpc.Operation[InputT, OutputT], input: InputT, *, output_type: type[OutputT] | None = None, schedule_to_close_timeout: timedelta | None = None, cancellation_type: NexusOperationCancellationType = NexusOperationCancellationType.WAIT_COMPLETED, headers: Mapping[str, str] | None = None) -> NexusOperationHandle[OutputT]:

@overload
@abstractmethod

async def start_operation(self, operation: str, input: Any, *, output_type: type[OutputT] | None = None, schedule_to_close_timeout: timedelta | None = None, cancellation_type: NexusOperationCancellationType = NexusOperationCancellationType.WAIT_COMPLETED, headers: Mapping[str, str] | None = None) -> NexusOperationHandle[OutputT]:

@overload
@abstractmethod

async def start_operation(self, operation:

Callable[[ServiceHandlerT, temporalio.nexus.WorkflowRunOperationContext, InputT], Awaitable[temporalio.nexus.WorkflowHandle[OutputT]]]

@overload
@abstractmethod

async def start_operation(self, operation: Callable[[ServiceHandlerT, nexusrpc.handler.StartOperationContext, InputT], Awaitable[OutputT]], input: InputT, *, output_type: type[OutputT] | None = None, schedule_to_close_timeout: timedelta | None = None, cancellation_type: NexusOperationCancellationType = NexusOperationCancellationType.WAIT_COMPLETED, headers: Mapping[str, str] | None = None) -> NexusOperationHandle[OutputT]:

@overload
@abstractmethod

async def start_operation(self, operation: Callable[[ServiceHandlerT, nexusrpc.handler.StartOperationContext, InputT], OutputT], input: InputT, *, output_type: type[OutputT] | None = None, schedule_to_close_timeout: timedelta | None = None, cancellation_type: NexusOperationCancellationType = NexusOperationCancellationType.WAIT_COMPLETED, headers: Mapping[str, str] | None = None) -> NexusOperationHandle[OutputT]:

@abstractmethod
(source) ¶

overridden in temporalio.workflow._NexusClient

Start a Nexus operation and return its handle.

Parameters
operation:`Any`	The Nexus operation.
input:`Any`	The Nexus operation input.
output_type:`type[OutputT] \| None`	The Nexus operation output type.
schedule_to_close_timeout:`timedelta \| None`	Timeout for the entire operation attempt.
cancellation_type:`NexusOperationCancellationType`	Undocumented
headers:`Mapping[str, str] \| None`	Headers to send with the Nexus HTTP request.
Returns
`Any`	A handle to the Nexus operation. The result can be obtained as `python await handle.result() `