temporalio.nexus._token.WorkflowHandle

class documentation

class WorkflowHandle(Generic[OutputT]): (source)

A handle to a workflow that is backing a Nexus operation.

Warning

This API is experimental and unstable.

Do not instantiate this directly. Use temporalio.nexus.WorkflowRunOperationContext.start_workflow to create a handle.

Class Method	`from_token`	Decodes and validates a token from its base64url-encoded string representation.
Method	`to_token`	Convert handle to a base64url-encoded token string.
Class Variable	`namespace`	Undocumented
Class Variable	`version`	Undocumented
Class Variable	`workflow_id`	Undocumented
Class Method	`_unsafe_from_client_workflow_handle`	Create a `WorkflowHandle` from a `temporalio.client.WorkflowHandle`.
Method	`_to_client_workflow_handle`	Create a `temporalio.client.WorkflowHandle` from the token.

@classmethod
def from_token(cls, token: str) -> WorkflowHandle[OutputT]: (source) ¶

Decodes and validates a token from its base64url-encoded string representation.

def to_token(self) -> str: (source) ¶

Convert handle to a base64url-encoded token string.

namespace: str = (source) ¶

Undocumented

version: int | None = (source) ¶

Undocumented

workflow_id: str = (source) ¶

Undocumented

@classmethod
def _unsafe_from_client_workflow_handle(cls, workflow_handle: client.WorkflowHandle[Any, OutputT]) -> WorkflowHandle[OutputT]: (source) ¶

Create a WorkflowHandle from a temporalio.client.WorkflowHandle.

This is a private method not intended to be used by users. It does not check that the supplied client.WorkflowHandle references a workflow that has been instrumented to supply the result of a Nexus operation.

def _to_client_workflow_handle(self, client: client.Client, result_type: type[OutputT] | None = None) -> client.WorkflowHandle[Any, OutputT]: (source) ¶

Create a temporalio.client.WorkflowHandle from the token.