Package kalix.javasdk.workflow

Interface AbstractWorkflow.Effect<T>

Type Parameters:

T - The type of the message that must be returned by this call.

All Known Subinterfaces:

AbstractWorkflow.Effect.ErrorEffect<T>, AbstractWorkflow.Effect.TransitionalEffect<T>

Enclosing class:

AbstractWorkflow<S>

public static interface AbstractWorkflow.Effect<T>

An Effect is a description of what Kalix needs to do after the command is handled. You can think of it as a set of instructions you are passing to Kalix. Kalix will process the instructions on your behalf and ensure that any data that needs to be persisted will be persisted.

Each Kalix component defines its own effects, which are a set of predefined operations that match the capabilities of that component.

A Workflow Effect can either:

• update the state of the workflow
• define the next step to be executed (transition)
• pause the workflow
• end the workflow
• fail the step or reject a command by returning an error
• reply to incoming commands

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AbstractWorkflow.Effect.Builder<S>	Construct the effect that is returned by the command handler or a step transition.
static interface	AbstractWorkflow.Effect.ErrorEffect<T>
static interface	AbstractWorkflow.Effect.PersistenceEffectBuilder<T>
static interface	AbstractWorkflow.Effect.TransitionalEffect<T>	A workflow effect type that contains information about the transition to the next step.