Package dev.restate.client

Interface Client

All Known Implementing Classes:

BaseClient, JdkClient

public interface Client

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Client.AwakeableHandle	This class represents a handle to an Awakeable.
static interface	Client.IdempotentInvocationHandle<Res>
static interface	Client.InvocationHandle<Res>
static interface	Client.WorkflowHandle<Res>

Method Summary

Modifier and Type	Method	Description
Client.AwakeableHandle	awakeableHandle(String id)	Create a new Client.AwakeableHandle for the provided identifier.
default <Req, Res> Response<Res>	call(Request<Req,Res> request)	Call a service and wait for the response.
<Req, Res> CompletableFuture<Response<Res>>	callAsync(Request<Req,Res> request)	Future version of call(Request)
static Client	connect(String baseUri)	Create a default JDK client.
static Client	connect(String baseUri, RequestOptions options)	Create a default JDK client.
static Client	connect(String baseUri, SerdeFactory serdeFactory)	Create a default JDK client.
static Client	connect(String baseUri, SerdeFactory serdeFactory, RequestOptions options)	Create a default JDK client.
<Res> Client.IdempotentInvocationHandle<Res>	idempotentInvocationHandle(Target target, String idempotencyKey, TypeTag<Res> resTypeTag)	Create a new Client.IdempotentInvocationHandle for the provided target and idempotency key.
default <Res> Client.IdempotentInvocationHandle<Res>	idempotentInvocationHandle(Target target, String idempotencyKey, Class<Res> clazz)	Create a new Client.IdempotentInvocationHandle for the provided target and idempotency key.
<Res> Client.InvocationHandle<Res>	invocationHandle(String invocationId, TypeTag<Res> resTypeTag)	Create a new Client.InvocationHandle for the provided invocation identifier.
default <Res> Client.InvocationHandle<Res>	invocationHandle(String invocationId, Class<Res> clazz)	Create a new Client.InvocationHandle for the provided invocation identifier.
default <Req, Res> SendResponse<Res>	send(Request<Req,Res> request)	Send a request to a service without waiting for the response.
default <Req, Res> SendResponse<Res>	send(Request<Req,Res> request, @Nullable Duration delay)	Send a request to a service without waiting for the response, optionally providing an execution delay to wait for.
default <Req, Res> CompletableFuture<SendResponse<Res>>	sendAsync(Request<Req,Res> request)	Future version of send(Request)
<Req, Res> CompletableFuture<SendResponse<Res>>	sendAsync(Request<Req,Res> request, @Nullable Duration delay)	Future version of send(Request, Duration)
default <Req, Res> SendResponse<Res>	submit(WorkflowRequest<Req,Res> request)	Submit a workflow.
default <Req, Res> SendResponse<Res>	submit(WorkflowRequest<Req,Res> request, @Nullable Duration delay)	Submit a workflow, optionally providing an execution delay to wait for.
default <Req, Res> CompletableFuture<SendResponse<Res>>	submitAsync(WorkflowRequest<Req,Res> request)	Future version of submit(WorkflowRequest)
default <Req, Res> CompletableFuture<SendResponse<Res>>	submitAsync(WorkflowRequest<Req,Res> request, @Nullable Duration delay)	Future version of submit(WorkflowRequest, Duration)
<Res> Client.WorkflowHandle<Res>	workflowHandle(String workflowName, String workflowId, TypeTag<Res> resTypeTag)	Create a new Client.WorkflowHandle for the provided workflow name and identifier.
default <Res> Client.WorkflowHandle<Res>	workflowHandle(String workflowName, String workflowId, Class<Res> clazz)	Create a new Client.WorkflowHandle for the provided workflow name and identifier.

Method Details

callAsync

<Req,
Res> CompletableFuture<Response<Res>> callAsync(Request<Req,Res> request)

Future version of call(Request)

See Also:

• call(Request)

call

default <Req,
Res> Response<Res> call(Request<Req,Res> request)
                               throws IngressException

Call a service and wait for the response.

Throws:

IngressException

sendAsync

default <Req,
Res>
CompletableFuture<SendResponse<Res>> sendAsync(Request<Req,Res> request)

Future version of send(Request)

See Also:

• send(Request)

send

default <Req,
Res> SendResponse<Res> send(Request<Req,Res> request)
                                   throws IngressException

Send a request to a service without waiting for the response.

Throws:

IngressException

sendAsync

<Req,
Res> CompletableFuture<SendResponse<Res>> sendAsync(Request<Req,Res> request,
 @Nullable Duration delay)

Future version of send(Request, Duration)

See Also:

• send(Request, Duration)

send

default <Req,
Res> SendResponse<Res> send(Request<Req,Res> request,
 @Nullable Duration delay)
                                   throws IngressException

Send a request to a service without waiting for the response, optionally providing an execution delay to wait for.

Throws:

IngressException

submitAsync

default <Req,
Res>
CompletableFuture<SendResponse<Res>> submitAsync(WorkflowRequest<Req,Res> request)

Future version of submit(WorkflowRequest)

See Also:

• submit(WorkflowRequest)

submit

default <Req,
Res> SendResponse<Res> submit(WorkflowRequest<Req,Res> request)
                                     throws IngressException

Submit a workflow.

Throws:

IngressException

submitAsync

default <Req,
Res>
CompletableFuture<SendResponse<Res>> submitAsync(WorkflowRequest<Req,Res> request,
 @Nullable Duration delay)

Future version of submit(WorkflowRequest, Duration)

See Also:

• submit(WorkflowRequest, Duration)

submit

default <Req,
Res> SendResponse<Res> submit(WorkflowRequest<Req,Res> request,
 @Nullable Duration delay)
                                     throws IngressException

Submit a workflow, optionally providing an execution delay to wait for.

Throws:

IngressException

awakeableHandle

Client.AwakeableHandle awakeableHandle(String id)

Create a new Client.AwakeableHandle for the provided identifier. You can use it to Client.AwakeableHandle.resolve(TypeTag, Object) or Client.AwakeableHandle.reject(String) an Awakeable from the ingress.

invocationHandle

<Res> Client.InvocationHandle<Res> invocationHandle(String invocationId,
 TypeTag<Res> resTypeTag)

Create a new Client.InvocationHandle for the provided invocation identifier.

Parameters:

invocationId - the invocation identifier

resTypeTag - type tag used to deserialize the invocation result

Returns:

the invocation handle

invocationHandle

default <Res> Client.InvocationHandle<Res> invocationHandle(String invocationId,
 Class<Res> clazz)

Create a new Client.InvocationHandle for the provided invocation identifier.

Parameters:

invocationId - the invocation identifier

clazz - used to deserialize the invocation result

Returns:

the invocation handle

idempotentInvocationHandle

<Res> Client.IdempotentInvocationHandle<Res> idempotentInvocationHandle(Target target,
 String idempotencyKey,
 TypeTag<Res> resTypeTag)

Create a new Client.IdempotentInvocationHandle for the provided target and idempotency key.

Parameters:

target - the target service/method

idempotencyKey - the idempotency key

resTypeTag - type tag used to deserialize the invocation result

Returns:

the idempotent invocation handle

idempotentInvocationHandle

default <Res>
Client.IdempotentInvocationHandle<Res> idempotentInvocationHandle(Target target,
 String idempotencyKey,
 Class<Res> clazz)

Create a new Client.IdempotentInvocationHandle for the provided target and idempotency key.

Parameters:

target - the target service/method

idempotencyKey - the idempotency key

clazz - used to deserialize the invocation result

Returns:

the idempotent invocation handle

workflowHandle

<Res> Client.WorkflowHandle<Res> workflowHandle(String workflowName,
 String workflowId,
 TypeTag<Res> resTypeTag)

Create a new Client.WorkflowHandle for the provided workflow name and identifier.

Parameters:

workflowName - the workflow name

workflowId - the workflow identifier

resTypeTag - type tag used to deserialize the invocation result

Returns:

the workflow handle

workflowHandle

default <Res> Client.WorkflowHandle<Res> workflowHandle(String workflowName,
 String workflowId,
 Class<Res> clazz)

Create a new Client.WorkflowHandle for the provided workflow name and identifier.

Parameters:

workflowName - the workflow name

workflowId - the workflow identifier

clazz - used to deserialize the workflow result

Returns:

the workflow handle

connect

static Client connect(String baseUri)

Create a default JDK client.

Parameters:

baseUri - uri to connect to.

connect

static Client connect(String baseUri,
 RequestOptions options)

Create a default JDK client.

Parameters:

baseUri - uri to connect to

options - default options to use in all the requests.

connect

static Client connect(String baseUri,
 SerdeFactory serdeFactory)

Create a default JDK client.

Parameters:

baseUri - uri to connect to

serdeFactory - Serde factory to use. If you're just wrapping this client in a code-generated client, you don't need to provide this parameter.

connect

static Client connect(String baseUri,
 SerdeFactory serdeFactory,
 RequestOptions options)

Create a default JDK client.

Parameters:

baseUri - uri to connect to

serdeFactory - Serde factory to use. If you're just wrapping this client in a code-generated client, you don't need to provide this parameter.

options - default options to use in all the requests.