Package akka.javasdk.workflow

Interface Workflow.StepEffect.Builder<S>

Type Parameters:
S - The type of the state for this workflow.
Enclosing interface:
Workflow.StepEffect
public static interface Workflow.StepEffect.Builder<S>
Construct the step effect that is returned by step method.

The step effect describes next processing actions, such as updating state and transition to another step.

  • Method Details

    • updateState

      Workflow.StepEffect.PersistenceEffectBuilder updateState(S newState)

    • thenPause

      Workflow.StepEffect thenPause()
      Pause the workflow execution and wait for an external input, e.g. via command handler.

    • thenTransitionTo

      <W> Workflow.StepEffect thenTransitionTo(akka.japi.function.Function<W,Workflow.StepEffect> stepName)
      Defines the next step to which the workflow should transition to.

      The step is identified by a method reference that accepts no input parameters.

      Type Parameters:
      W - The workflow type containing the step method
      Parameters:
      stepName - Reference to the step method
      Returns:
      A step effect

    • thenTransitionTo

      <W, I> Workflow.WithInput<I,Workflow.StepEffect> thenTransitionTo(akka.japi.function.Function2<W,I,Workflow.StepEffect> lambda)
      Defines the next step to which the workflow should transition to.

      The step is identified by a method reference that accepts an input parameter.

      Type Parameters:
      W - The workflow type containing the step method
      I - The input parameter type for the step
      Parameters:
      lambda - Reference to the step method
      Returns:
      A builder to provide the input parameter

    • thenEnd

      Workflow.StepEffect thenEnd()
      Finish the workflow execution. After transition to end, no more transitions are allowed.

    • thenDelete

      Workflow.StepEffect thenDelete()
      Finish and delete the workflow execution. After transition to delete, no more transitions are allowed. The actual workflow state deletion is done with a configurable delay to allow downstream consumers to observe that fact.