package temporal.api.update.v1

Get desktop application:
View/edit binary Protocol Buffers messages

An Update protocol message indicating that a Workflow Update has been accepted (i.e. passed the worker-side validation phase).

• string accepted_request_message_id = 1

• int64 accepted_request_sequencing_event_id = 2

• optional Request accepted_request = 3

Used in: Request

• optional common.v1.Header header = 1

  Headers that are passed with the Update from the requesting entity. These can include things like auth or tracing tokens.

• string name = 2

  The name of the Update handler to invoke on the target Workflow.

• optional common.v1.Payloads args = 3

  The arguments to pass to the named Update handler.

Metadata about a Workflow Update.

Used in: history.v1.WorkflowExecutionUpdateCompletedEventAttributes, Request, Response

• string update_id = 1

  An ID with workflow-scoped uniqueness for this Update.

• string identity = 2

  A string identifying the agent that requested this Update.

The outcome of a Workflow Update: success or failure.

Used in: history.v1.WorkflowExecutionUpdateCompletedEventAttributes, Response, workflowservice.v1.PollWorkflowExecutionUpdateResponse, workflowservice.v1.UpdateWorkflowExecutionResponse

• oneof value

  • common.v1.Payloads success = 1

  • failure.v1.Failure failure = 2

An Update protocol message indicating that a Workflow Update has been rejected.

• string rejected_request_message_id = 1

• int64 rejected_request_sequencing_event_id = 2

• optional Request rejected_request = 3

• optional failure.v1.Failure failure = 4

The client request that triggers a Workflow Update.

Used in: history.v1.WorkflowExecutionUpdateAcceptedEventAttributes, history.v1.WorkflowExecutionUpdateAdmittedEventAttributes, history.v1.WorkflowExecutionUpdateRejectedEventAttributes, Acceptance, Rejection, workflowservice.v1.UpdateWorkflowExecutionRequest

• optional Meta meta = 1

• optional Input input = 2

• string request_id = 3

  The request ID of the request.

• repeated common.v1.Callback completion_callbacks = 4

  Callbacks to be called by the server when this update reaches a terminal state.

• repeated common.v1.Link links = 5

  Links to be associated with this update.

An Update protocol message indicating that a Workflow Update has completed with the contained outcome.

• optional Meta meta = 1

• optional Outcome outcome = 2

The data needed by a client to refer to a previously invoked Workflow Update.

Used in: workflowservice.v1.PollWorkflowExecutionUpdateRequest, workflowservice.v1.PollWorkflowExecutionUpdateResponse, workflowservice.v1.UpdateWorkflowExecutionResponse

• optional common.v1.WorkflowExecution workflow_execution = 1

• string update_id = 2

Specifies client's intent to wait for Update results.

Used in: workflowservice.v1.PollWorkflowExecutionUpdateRequest, workflowservice.v1.UpdateWorkflowExecutionRequest

• enums.v1.UpdateWorkflowExecutionLifecycleStage lifecycle_stage = 1

  Indicates the Update lifecycle stage that the Update must reach before API call is returned. NOTE: This field works together with API call timeout which is limited by server timeout (maximum wait time). If server timeout is expired before user specified timeout, API call returns even if specified stage is not reached.