temporalio.workflow._NexusClient

class documentation

class _NexusClient(NexusClient[ServiceT]): (source)

Constructor: _NexusClient(endpoint, service)

View In Hierarchy

Undocumented

Method __init__ Create a Nexus client.
Async Method execute_operation Execute a Nexus operation and return its result.
Async Method start_operation Start a Nexus operation and return its handle.
Instance Variable endpoint Undocumented
Instance Variable service_name Undocumented
def __init__(self, *, endpoint: str, service: type[ServiceT] | str): (source)

Create a Nexus client.

Parameters
endpoint:strThe Nexus endpoint.
service:type[ServiceT] | strThe Nexus service.
async def execute_operation(self, operation: Any, input: Any, *, output_type: type | None = None, schedule_to_close_timeout: timedelta | None = None, cancellation_type: NexusOperationCancellationType = NexusOperationCancellationType.WAIT_COMPLETED, headers: Mapping[str, str] | None = None) -> Any: (source)
overrides temporalio.workflow.NexusClient.execute_operation

Execute a Nexus operation and return its result.

Parameters
operation:AnyThe Nexus operation.
input:AnyThe Nexus operation input.
output_type:type | NoneThe Nexus operation output type.
schedule_to_close_timeout:timedelta | NoneTimeout for the entire operation attempt.
cancellation_type:NexusOperationCancellationTypeUndocumented
headers:Mapping[str, str] | NoneHeaders to send with the Nexus HTTP request.
Returns
AnyThe operation result.
async def start_operation(self, operation: Any, input: Any, *, output_type: type | None = None, schedule_to_close_timeout: timedelta | None = None, cancellation_type: NexusOperationCancellationType = NexusOperationCancellationType.WAIT_COMPLETED, headers: Mapping[str, str] | None = None) -> Any: (source)
overrides temporalio.workflow.NexusClient.start_operation

Start a Nexus operation and return its handle.

Parameters
operation:AnyThe Nexus operation.
input:AnyThe Nexus operation input.
output_type:type | NoneThe Nexus operation output type.
schedule_to_close_timeout:timedelta | NoneTimeout for the entire operation attempt.
cancellation_type:NexusOperationCancellationTypeUndocumented
headers:Mapping[str, str] | NoneHeaders to send with the Nexus HTTP request.
Returns
AnyA handle to the Nexus operation. The result can be obtained as `python await handle.result() `
endpoint = (source)

Undocumented

service_name = (source)

Undocumented