Skip to main content

Interface: IUpdateWorkflowExecutionResponse

Properties of an UpdateWorkflowExecutionResponse.

Extends​

Properties​

optional link?: $Properties | null

Link to the update event. May be null if the update has not yet been accepted.

Inherited from​

$Properties.link

outcome?​

optional outcome?: $Properties | null

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

Inherited from​

$Properties.outcome

propagatedNexusSerializationContext?​

optional propagatedNexusSerializationContext?: $Properties | null

Serialization context propagated from the Nexus caller that started this update.

Inherited from​

$Properties.propagatedNexusSerializationContext

stage?​

optional stage?: UpdateWorkflowExecutionLifecycleStage | null

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.

Inherited from​

$Properties.stage

updateRef?​

optional updateRef?: $Properties | null

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

Inherited from​

$Properties.updateRef