Package kalix.javasdk.workflowentity

Class WorkflowEntity.Workflow<S>

Object

kalix.javasdk.workflowentity.WorkflowEntity.Workflow<S>

Enclosing class:

WorkflowEntity<S>

public static class WorkflowEntity.Workflow<S>
extends Object

Method Summary

Modifier and Type	Method	Description
WorkflowEntity.Workflow<S>	addStep(WorkflowEntity.Step step)	Add step to workflow definition.
WorkflowEntity.Workflow<S>	addStep(WorkflowEntity.Step step, WorkflowEntity.RecoverStrategy<?> recoverStrategy)	Add step to workflow definition with a dedicated WorkflowEntity.RecoverStrategy.
WorkflowEntity.Workflow<S>	defaultStepRecoverStrategy(WorkflowEntity.RecoverStrategy recoverStrategy)	Define a default step recovery strategy.
WorkflowEntity.Workflow<S>	defaultStepTimeout(Duration timeout)	Define a default step timeout.
<I> WorkflowEntity.Workflow<S>	failoverTo(String stepName, I stepInput, WorkflowEntity.RecoverStrategy.MaxRetries maxRetries)	Define a failover step name after workflow timeout.
WorkflowEntity.Workflow<S>	failoverTo(String stepName, WorkflowEntity.RecoverStrategy.MaxRetries maxRetries)	Define a failover step name after workflow timeout.
Optional<WorkflowEntity.Step>	findByName(String name)
void	forEachStep(Consumer<WorkflowEntity.Step> stepConsumer)
Optional<WorkflowEntity.RecoverStrategy.MaxRetries>	getFailoverMaxRetries()
Optional<?>	getFailoverStepInput()
Optional<String>	getFailoverStepName()
List<WorkflowEntity.StepConfig>	getStepConfigs()
Optional<WorkflowEntity.RecoverStrategy<?>>	getStepRecoverStrategy()
List<WorkflowEntity.Step>	getSteps()
Optional<Duration>	getStepTimeout()
Optional<Duration>	getWorkflowTimeout()
WorkflowEntity.Workflow<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<WorkflowEntity.Step> findByName(String name)

addStep

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

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

Parameters:

step - A workflow step

addStep

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

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

Parameters:

step - A workflow step

recoverStrategy - A Step recovery strategy

forEachStep

public void forEachStep(Consumer<WorkflowEntity.Step> stepConsumer)

timeout

public WorkflowEntity.Workflow<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 WorkflowEntity.Workflow<S> failoverTo(String stepName,
 WorkflowEntity.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> WorkflowEntity.Workflow<S> failoverTo(String stepName,
 I stepInput,
 WorkflowEntity.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 WorkflowEntity.Workflow<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 WorkflowEntity.Workflow<S> defaultStepRecoverStrategy(WorkflowEntity.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<WorkflowEntity.RecoverStrategy<?>> getStepRecoverStrategy()

getSteps

public List<WorkflowEntity.Step> getSteps()

getStepConfigs

public List<WorkflowEntity.StepConfig> getStepConfigs()

getFailoverStepName

public Optional<String> getFailoverStepName()

getFailoverStepInput

public Optional<?> getFailoverStepInput()

getFailoverMaxRetries

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