Package akka.javasdk.workflow

Interface Workflow.Effect.PersistenceEffectBuilder<T>

Enclosing interface:
Workflow.Effect<T>
public static interface Workflow.Effect.PersistenceEffectBuilder<T>

  • Method Details

    • pause

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

    • pause

      Workflow.Effect.Transitional pause(String reason)
      Pause the workflow execution with a reason description and wait for an external input, e.g. via command handler.

    • pause

      Workflow.Effect.Transitional pause(Workflow.PauseSettings pauseSettings)
      Pause the workflow execution with advanced configuration options.

      This method allows pausing the workflow with a timeout and a handler that will be invoked when the timeout expires. The pause can also include an optional reason description.

      Use the Workflow.pauseSetting(Duration) method to start building the Workflow.PauseSettings.

      Parameters:
      pauseSettings - Configuration for the pause including timeout duration and handler

    • transitionTo

      <W> Workflow.Effect.Transitional transitionTo(akka.japi.function.Function<W,Workflow.StepEffect> lambda)
      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:
      lambda - Reference to the step method
      Returns:
      A transitional effect

    • transitionTo

      <W, I> Workflow.WithInput<I,Workflow.Effect.Transitional> transitionTo(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

    • end

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

    • end

      Workflow.Effect.Transitional end(String reason)
      Finish the workflow execution with a reason description. After transition to end, no more transitions are allowed.

    • delete

      Workflow.Effect.Transitional delete()
      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.

    • delete

      Workflow.Effect.Transitional delete(String reason)
      Finish and delete the workflow execution with a reason description. 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.