Package akka.javasdk.workflow
Interface Workflow.Effect.Builder<S>
- Type Parameters:
S
- The type of the state for this workflow.
- Enclosing interface:
Workflow.Effect<T>
public static interface Workflow.Effect.Builder<S>
Construct the effect that is returned by the command handler or a step transition.
The effect describes next processing actions, such as updating state, transition to another step and sending a reply.
-
Method Summary
Modifier and TypeMethodDescriptionend()
Finish the workflow execution.<R> Workflow.ReadOnlyEffect
<R> Create an error reply.pause()
Pause the workflow execution and wait for an external input, e.g.<R> Workflow.ReadOnlyEffect
<R> reply
(R replyMessage) Create a message reply.<R> Workflow.ReadOnlyEffect
<R> Reply after for exampleupdateState
.transitionTo
(String stepName) Defines the next step to which the workflow should transition to.transitionTo
(String stepName, I input) Defines the next step to which the workflow should transition to.updateState
(S newState)
-
Method Details
-
updateState
-
pause
Workflow.Effect.TransitionalEffect<Void> pause()Pause the workflow execution and wait for an external input, e.g. via command handler. -
transitionTo
Defines the next step to which the workflow should transition to.The step definition identified by
stepName
must have an input parameter of type I. In other words, the next step call (or asyncCall) must have been defined with aFunction
that accepts an input parameter of type I.- Parameters:
stepName
- The step name that should be executed next.input
- The input param for the next step.
-
transitionTo
Defines the next step to which the workflow should transition to.The step definition identified by
stepName
must not have an input parameter. In other words, the next step call (or asyncCall) must have been defined with aSupplier
function.- Parameters:
stepName
- The step name that should be executed next.
-
end
Finish the workflow execution. After transition toend
, no more transitions are allowed. -
reply
Create a message reply.- Type Parameters:
R
- The type of the message that must be returned by this call.- Parameters:
replyMessage
- The payload of the reply.- Returns:
- A message reply.
-
reply
Reply after for exampleupdateState
.- Type Parameters:
R
- The type of the message that must be returned by this call.- Parameters:
message
- The payload of the reply.metadata
- The metadata for the message.- Returns:
- A message reply.
-
error
Create an error reply.- Type Parameters:
R
- The type of the message that must be returned by this call.- Parameters:
description
- The description of the error.- Returns:
- An error reply.
-