Package akka.javasdk.workflow

Class Workflow.WorkflowDef<S>

Object

akka.javasdk.workflow.Workflow.WorkflowDef<S>

Enclosing class:

Workflow<S>

public static class Workflow.WorkflowDef<S>
extends Object

Method Summary

Modifier and Type	Method	Description
Workflow.WorkflowDef<S>	addStep(Workflow.Step step)	Add step to workflow definition.
Workflow.WorkflowDef<S>	addStep(Workflow.Step step, Workflow.RecoverStrategy<?> recoverStrategy)	Add step to workflow definition with a dedicated Workflow.RecoverStrategy.
Workflow.WorkflowDef<S>	defaultStepRecoverStrategy(Workflow.RecoverStrategy recoverStrategy)	Define a default step recovery strategy.
Workflow.WorkflowDef<S>	defaultStepTimeout(Duration timeout)	Define a default step timeout.
Workflow.WorkflowDef<S>	failoverTo(String stepName, Workflow.RecoverStrategy.MaxRetries maxRetries)	Define a failover step name after workflow timeout.
<I> Workflow.WorkflowDef<S>	failoverTo(String stepName, I stepInput, Workflow.RecoverStrategy.MaxRetries maxRetries)	Define a failover step name after workflow timeout.
Optional<Workflow.Step>	findByName(String name)
Optional<Workflow.RecoverStrategy.MaxRetries>	getFailoverMaxRetries()
Optional<?>	getFailoverStepInput()
Optional<String>	getFailoverStepName()
List<Workflow.StepConfig>	getStepConfigs()
Optional<Workflow.RecoverStrategy<?>>	getStepRecoverStrategy()
List<Workflow.Step>	getSteps()
Optional<Duration>	getStepTimeout()
Optional<Duration>	getWorkflowTimeout()
Workflow.WorkflowDef<S>	timeout(Duration timeout)	Define a timeout for the duration of the entire workflow.

Methods inherited from class java.lang.Object

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

Method Details

findByName

public Optional<Workflow.Step> findByName(String name)

addStep

public Workflow.WorkflowDef<S> addStep(Workflow.Step step)

Add step to workflow definition. Step name must be unique.

Parameters:

step - A workflow step

addStep

public Workflow.WorkflowDef<S> addStep(Workflow.Step step,
 Workflow.RecoverStrategy<?> recoverStrategy)

Add step to workflow definition with a dedicated Workflow.RecoverStrategy. Step name must be unique.

Parameters:

step - A workflow step

recoverStrategy - A Step recovery strategy

timeout

public Workflow.WorkflowDef<S> timeout(Duration timeout)

Define a timeout for the duration of the entire workflow. When the timeout expires, the workflow is finished and no transitions are allowed.

Parameters:

timeout - Timeout duration

failoverTo

public Workflow.WorkflowDef<S> failoverTo(String stepName,
 Workflow.RecoverStrategy.MaxRetries maxRetries)

Define a failover step name after workflow timeout. Note that recover strategy for this step can set only the number of max retries.

Parameters:

stepName - A failover step name

maxRetries - A recovery strategy for failover step.

failoverTo

public <I> Workflow.WorkflowDef<S> failoverTo(String stepName,
 I stepInput,
 Workflow.RecoverStrategy.MaxRetries maxRetries)

Define a failover step name after workflow timeout. Note that recover strategy for this step can set only the number of max retries.

Parameters:

stepName - A failover step name

stepInput - A failover step input

maxRetries - A recovery strategy for failover step.

defaultStepTimeout

public Workflow.WorkflowDef<S> defaultStepTimeout(Duration timeout)

Define a default step timeout. If not set, a default value of 5 seconds is used. Can be overridden with step configuration.

defaultStepRecoverStrategy

public Workflow.WorkflowDef<S> defaultStepRecoverStrategy(Workflow.RecoverStrategy recoverStrategy)

Define a default step recovery strategy. Can be overridden with step configuration.

getWorkflowTimeout

public Optional<Duration> getWorkflowTimeout()

getStepTimeout

public Optional<Duration> getStepTimeout()

getStepRecoverStrategy

public Optional<Workflow.RecoverStrategy<?>> getStepRecoverStrategy()

getSteps

public List<Workflow.Step> getSteps()

getStepConfigs

public List<Workflow.StepConfig> getStepConfigs()

getFailoverStepName

public Optional<String> getFailoverStepName()

getFailoverStepInput

public Optional<?> getFailoverStepInput()

getFailoverMaxRetries

public Optional<Workflow.RecoverStrategy.MaxRetries> getFailoverMaxRetries()