temporalio.nexus._temporal_client._TemporalNexusClient

class documentation

class _TemporalNexusClient(TemporalNexusClient): (source)

Constructor: _TemporalNexusClient()

View In Hierarchy

Nexus-aware wrapper around a Temporal Client.

Warning

This API is experimental and unstable.

Method __init__ Initialize the client wrapper from the active Nexus operation context.
Async Method start_activity Start a standalone activity that will deliver the Nexus operation result.
Async Method start_workflow Start a workflow as the backing asynchronous Nexus operation.
Async Method start_workflow_update Start a Workflow Update-backed Nexus Operation.
Property client Return the Temporal client for the active Nexus operation.
Method _reserve_async_start Undocumented
Instance Variable _started_async Undocumented
Instance Variable _temporal_context Undocumented
def __init__(self): (source)

Initialize the client wrapper from the active Nexus operation context.

async def start_activity(self, activity: str | Callable[..., Awaitable[ReturnType]] | Callable[..., ReturnType], arg: Any = temporalio.common._arg_unset, *, args: Sequence[Any] = [], id: str, task_queue: str | None = None, result_type: type | None = None, schedule_to_start_timeout: timedelta | None = None, schedule_to_close_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, start_delay: timedelta | None = None, id_reuse_policy: temporalio.common.ActivityIDReusePolicy = temporalio.common.ActivityIDReusePolicy.ALLOW_DUPLICATE, id_conflict_policy: temporalio.common.ActivityIDConflictPolicy = temporalio.common.ActivityIDConflictPolicy.FAIL, retry_policy: temporalio.common.RetryPolicy | None = None, search_attributes: temporalio.common.TypedSearchAttributes | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default, rpc_metadata: Mapping[str, str | bytes] = {}, rpc_timeout: timedelta | None = None) -> TemporalOperationResult[ReturnType]: (source)
overrides temporalio.nexus.TemporalNexusClient.start_activity

Start a standalone activity that will deliver the Nexus operation result.

If task_queue is not specified, the Nexus worker's task queue is used. See temporalio.client.Client.start_activity for all other arguments.

async def start_workflow(self, workflow: str | Callable[..., Awaitable[ReturnType]], arg: Any = temporalio.common._arg_unset, *, args: Sequence[Any] = [], id: str, task_queue: str | None = None, result_type: type | None = None, execution_timeout: timedelta | None = None, run_timeout: timedelta | None = None, task_timeout: timedelta | None = None, id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = temporalio.common.WorkflowIDReusePolicy.ALLOW_DUPLICATE, id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy = temporalio.common.WorkflowIDConflictPolicy.UNSPECIFIED, retry_policy: temporalio.common.RetryPolicy | None = None, cron_schedule: str = '', memo: Mapping[str, Any] | None = None, search_attributes: None | temporalio.common.TypedSearchAttributes | temporalio.common.SearchAttributes = None, static_summary: str | None = None, static_details: str | None = None, start_delay: timedelta | None = None, start_signal: str | None = None, start_signal_args: Sequence[Any] = [], rpc_metadata: Mapping[str, str | bytes] = {}, rpc_timeout: timedelta | None = None, request_eager_start: bool = False, priority: temporalio.common.Priority = temporalio.common.Priority.default, versioning_override: temporalio.common.VersioningOverride | None = None) -> TemporalOperationResult[ReturnType]: (source)
overrides temporalio.nexus.TemporalNexusClient.start_workflow

Start a workflow as the backing asynchronous Nexus operation.

async def start_workflow_update(self, workflow_id: str, update: str | Callable, arg: Any = temporalio.common._arg_unset, *, args: Sequence[Any] = [], update_id: str | None = None, result_type: type | None = None, rpc_metadata: Mapping[str, str | bytes] = {}, rpc_timeout: timedelta | None = None, run_id: str | None = None, first_execution_run_id: str | None = None) -> TemporalOperationResult[Any]: (source)
overrides temporalio.nexus.TemporalNexusClient.start_workflow_update

Start a Workflow Update-backed Nexus Operation.

client: temporalio.client.Client = (source)
overrides temporalio.nexus.TemporalNexusClient.client

Return the Temporal client for the active Nexus operation.

def _reserve_async_start(self) -> Iterator[None]: (source)

Undocumented

_started_async: bool = (source)

Undocumented

_temporal_context = (source)

Undocumented