temporalio.client.WorkflowUpdateHandle

class documentation

class WorkflowUpdateHandle(Generic[LocalReturnType]): (source)

Constructor: WorkflowUpdateHandle(client, id, workflow_id, workflow_run_id, ...)

Handle for a workflow update execution request.

Method	`__init__`	Create a workflow update handle.
Async Method	`result`	Wait for and return the result of the update. The result may already be known in which case no network call is made. Otherwise the result will be polled for until it is returned.
Property	`id`	ID of this Update request.
Property	`workflow_id`	The ID of the Workflow targeted by this Update.
Property	`workflow_run_id`	If specified, the specific run of the Workflow targeted by this Update.
Async Method	`_poll_until_outcome`	Undocumented
Instance Variable	`_client`	Undocumented
Instance Variable	`_id`	Undocumented
Instance Variable	`_known_outcome`	Undocumented
Instance Variable	`_result_type`	Undocumented
Instance Variable	`_workflow_id`	Undocumented
Instance Variable	`_workflow_run_id`	Undocumented

def __init__(self, client: Client, id: str, workflow_id: str, *, workflow_run_id: Optional[str] = None, result_type: Optional[Type] = None, known_outcome: Optional[temporalio.api.update.v1.Outcome] = None): (source) ¶

Create a workflow update handle.

Users should not create this directly, but rather use WorkflowHandle.start_update or WorkflowHandle.get_update_handle.

async def result(self, *, rpc_metadata: Mapping[str, str] = {}, rpc_timeout: Optional[timedelta] = None) -> LocalReturnType: (source) ¶

Wait for and return the result of the update. The result may already be known in which case no network call is made. Otherwise the result will be polled for until it is returned.

Parameters
rpc_metadata:`Mapping[str, str]`	Headers used on the RPC call. Keys here override client-level RPC metadata keys.
rpc_timeout:`Optional[timedelta]`	Optional RPC deadline to set for each RPC call. Note: this is the timeout for each RPC call while polling, not a timeout for the function as a whole. If an individual RPC times out, it will be retried until the result is available.
Returns
`LocalReturnType`	Undocumented
Raises
`WorkflowUpdateFailedError`	If the update failed.
`WorkflowUpdateRPCTimeoutOrCancelledError`	This update call timed out or was cancelled. This doesn't mean the update itself was timed out or cancelled.
`RPCError`	Update result could not be fetched for some other reason.