Package akka.javasdk.workflow

Class StepBuilder

Object

akka.javasdk.workflow.StepBuilder

public class StepBuilder
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StepBuilder.AsyncCallStepBuilder<CallInput,CallOutput>
static class	StepBuilder.CallStepBuilder<Input,DefCallInput,DefCallOutput>

Constructor Summary

Constructors

Constructor	Description
StepBuilder(String name)

Method Summary

Modifier and Type	Method	Description
<Input, Output> StepBuilder.AsyncCallStepBuilder<Input,Output>	asyncCall(Class<Input> callInputClass, Function<Input,CompletionStage<Output>> callFactory)	Build a step action with an async call.
<Output> StepBuilder.AsyncCallStepBuilder<Void,Output>	asyncCall(Supplier<CompletionStage<Output>> callSupplier)	Build a step action with an async call.
StepBuilder	step(String stepName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StepBuilder

public StepBuilder(String name)

Method Details

step

public StepBuilder step(String stepName)

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 async call factory, provided by transition method.

Output - Output of 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 async call.

Parameters:

callSupplier - Factory method for creating async call.

Returns:

Step builder.