Skip to main content

Interface: IUpdateWorkflowExecutionResponse


Properties of an UpdateWorkflowExecutionResponse.

Implemented by



Optional outcome: null | IOutcome

The outcome of the update if and only if the workflow execution update has completed. If this response is being returned before the update has completed then this field will not be set.


Optional stage: null | UpdateWorkflowExecutionLifecycleStage

The most advanced lifecycle stage that the Update is known to have reached, where lifecycle stages are ordered UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED. UNSPECIFIED will be returned if and only if the server's maximum wait time was reached before the Update reached the stage specified in the request WaitPolicy, and before the context deadline expired; clients may may then retry the call as needed.


Optional updateRef: null | IUpdateRef

Enough information for subsequent poll calls if needed. Never null.