class documentation

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): (source)

Create a workflow update handle.

Users should not create this directly, but rather use Client.start_workflow_update.

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
LocalReturnTypeUndocumented
Raises
WorkflowUpdateFailedErrorIf the update failed
RPCErrorUpdate result could not be fetched for some other reason.

ID of this Update request.

@property
workflow_id: str = (source)

The ID of the Workflow targeted by this Update.

@property
workflow_run_id: Optional[str] = (source)

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

async def _poll_until_outcome(self, rpc_metadata: Mapping[str, str] = {}, rpc_timeout: Optional[timedelta] = None): (source)

Undocumented

Undocumented

Undocumented

_known_outcome = (source)

Undocumented

_result_type = (source)

Undocumented

_workflow_id = (source)

Undocumented

_workflow_run_id = (source)

Undocumented