Package kalix.javasdk.workflow

Class ProtoStepBuilder

Object

kalix.javasdk.workflow.ProtoStepBuilder

public class ProtoStepBuilder
extends Object

Step builder for defining a workflow step for Java protobuf SDK

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ProtoStepBuilder(String name)

Method Summary

Modifier and Type	Method	Description
<Input extends com.google.protobuf.GeneratedMessageV3, Output extends com.google.protobuf.GeneratedMessageV3> ProtoStepBuilder.AsyncCallStepBuilder<Input,Output>	asyncCall(Class<Input> callInputClass, Function<Input,CompletionStage<Output>> callFactory)	Build a step action with an async call.
<Output extends com.google.protobuf.GeneratedMessageV3> ProtoStepBuilder.AsyncCallStepBuilder<Void,Output>	asyncCall(Supplier<CompletionStage<Output>> callSupplier)	Build a step action with an async call.
<Input extends com.google.protobuf.GeneratedMessageV3, DefCallInput, DefCallOutput extends com.google.protobuf.GeneratedMessageV3> ProtoStepBuilder.CallStepBuilder<Input,DefCallInput,DefCallOutput>	call(Class<Input> callInputClass, Function<Input,DeferredCall<DefCallInput,DefCallOutput>> callFactory)	Build a step action with a call to an existing Kalix component via DeferredCall.
<DefCallInput, DefCallOutput extends com.google.protobuf.GeneratedMessageV3> ProtoStepBuilder.CallStepBuilder<Void,DefCallInput,DefCallOutput>	call(Supplier<DeferredCall<DefCallInput,DefCallOutput>> callSupplier)	Build a step action with a call to an existing Kalix component via DeferredCall.

Methods inherited from class java.lang.Object

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

Constructor Details

ProtoStepBuilder

public ProtoStepBuilder(String name)

Method Details

call

@ApiMayChange
public <Input extends com.google.protobuf.GeneratedMessageV3,
DefCallInput,
DefCallOutput extends com.google.protobuf.GeneratedMessageV3>
ProtoStepBuilder.CallStepBuilder<Input,DefCallInput,DefCallOutput> call(Class<Input> callInputClass,
 Function<Input,DeferredCall<DefCallInput,DefCallOutput>> callFactory)

Build a step action with a call to an existing Kalix component via DeferredCall.

The Function passed to this method should return a DeferredCall. The DeferredCall is then executed by Kalix and its result, if successful, 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 deferred call factory, provided by transition method.

DefCallInput - Input for deferred call.

DefCallOutput - Output of deferred call.

Parameters:

callInputClass - Input class for call factory.

callFactory - Factory method for creating deferred call.

Returns:

Step builder.

call

@ApiMayChange
public <DefCallInput,
DefCallOutput extends com.google.protobuf.GeneratedMessageV3>
ProtoStepBuilder.CallStepBuilder<Void,DefCallInput,DefCallOutput> call(Supplier<DeferredCall<DefCallInput,DefCallOutput>> callSupplier)

Build a step action with a call to an existing Kalix component via DeferredCall.

The Supplier function passed to this method should return a DeferredCall. The DeferredCall is then executed by Kalix and its result, if successful, 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:

DefCallInput - Input for deferred call.

DefCallOutput - Output of deferred call.

Parameters:

callSupplier - Factory method for creating deferred call.

Returns:

Step builder.

asyncCall

@ApiMayChange
public <Input extends com.google.protobuf.GeneratedMessageV3,
Output extends com.google.protobuf.GeneratedMessageV3>
ProtoStepBuilder.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

@ApiMayChange
public <Output extends com.google.protobuf.GeneratedMessageV3>
ProtoStepBuilder.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.