Package akka.javasdk.workflow

Class StepBuilder

Object
akka.javasdk.workflow.StepBuilder
public class StepBuilder extends Object

  • Constructor Details

    • StepBuilder

      public StepBuilder(String name)
      Not for direct user construction, instances are created through the workflow DSL

  • Method Details

    • step

      @Deprecated public StepBuilder step(String stepName)
      Deprecated.
      use methods returning Workflow.StepEffect instead.

    • call

      public <Input, Output> StepBuilder.CallStepBuilder<Input,Output> call(Class<Input> callInputClass, Function<Input,Output> callFactory)
      Build a step action with a call.

      The value returned by the call Function is made available to this workflow via the andThen method. In the andThen method, we can use the result to update the workflow state and transition to the next step.

      On failure, the step will be retried according to the default retry strategy or the one defined in the step configuration.

      Type Parameters:
      Input - Input for the call factory, provided by transition method.
      Output - Output of the call.
      Parameters:
      callInputClass - Input class for call factory.
      callFactory - Factory method for creating a call.
      Returns:
      Step builder.

    • call

      public <Output> StepBuilder.CallStepBuilder<Void,Output> call(Supplier<Output> callSupplier)
      Build a step action with a call.

      The value returned by the Supplier is made available to this workflow via the andThen method. In the andThen method, we can use the result to update the workflow state and transition to the next step.

      On failure, the step will be retried according to the default retry strategy or the one defined in the step configuration.

      Type Parameters:
      Output - Output of the call.
      Parameters:
      callSupplier - Factory method for creating a call.
      Returns:
      Step builder.

    • call

      public StepBuilder.RunnableStepBuilder call(Runnable runnable)
      Build a step action with a call.

      The Runnable passed to this method is executed and if successful, the andThen method is called. In the andThen method, we can update the workflow state and transition to the next step.

      On failure, the step will be retried according to the default retry strategy or the one defined in the step configuration.

      Returns:
      Step builder.

    • asyncCall

      public <Input, Output> StepBuilder.AsyncCallStepBuilder<Input,Output> asyncCall(Class<Input> callInputClass, Function<Input,CompletionStage<Output>> callFactory)
      Build a step action with an async call.

      The Function passed to this method should return a CompletionStage. On successful completion, its result is made available to this workflow via the andThen method. In the andThen method, we can use the result to update the workflow state and transition to the next step.

      On failure, the step will be retried according to the default retry strategy or the one defined in the step configuration.

      Type Parameters:
      Input - Input for the async call factory, provided by transition method.
      Output - Output of the async call.
      Parameters:
      callInputClass - Input class for call factory.
      callFactory - Factory method for creating async call.
      Returns:
      Step builder.

    • asyncCall

      public <Output> StepBuilder.AsyncCallStepBuilder<Void,Output> asyncCall(Supplier<CompletionStage<Output>> callSupplier)
      Build a step action with an async call.

      The Supplier function passed to this method should return a CompletionStage. On successful completion, its result is made available to this workflow via the andThen method. In the andThen method, we can use the result to update the workflow state and transition to the next step.

      On failure, the step will be retried according to the default retry strategy or the one defined in the step configuration.

      Type Parameters:
      Output - Output of the async call.
      Parameters:
      callSupplier - Factory method for creating async call.
      Returns:
      Step builder.