temporalio.client.WorkflowUpdateHandle

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
Property _data_converter Undocumented

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 | bytes]Headers used on the RPC call. Keys here override client-level RPC metadata keys.
rpc_timeout:timedelta | NoneOptional 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.

ID of this Update request.

The ID of the Workflow targeted by this Update.

If specified, the specific run of the Workflow targeted by this Update.