client/dev.restate.client.base/BaseClient

BaseClient

abstract class BaseClient : Client

Base client. This can be used to build Client implementations on top with the HTTP client of your choice.

Inheritors

JdkClient

Types

DefaultSerdeFactory

class DefaultSerdeFactory

Functions

awakeableHandle

open fun awakeableHandle(id: String): Client.AwakeableHandle

Create a new AwakeableHandle for the provided identifier.

call

open fun <Req, Res> call(request: Request<Req, Res>): Response<Res>

Call a service and wait for the response.

callAsync

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

Future version of call

connect

open fun connect(baseUri: String): Client

open fun connect(baseUri: String, options: RequestOptions): Client

open fun connect(baseUri: String, serdeFactory: SerdeFactory): Client

open fun connect(baseUri: String, serdeFactory: SerdeFactory, options: RequestOptions): Client

Create a default JDK client.

idempotentInvocationHandle

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

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

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

invocationHandle

open fun <Res> invocationHandle(invocationId: String, clazz: Class<Res>): Client.InvocationHandle<Res>

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

Create a new InvocationHandle for the provided invocation identifier.

send

open fun <Req, Res> send(request: Request<Req, Res>): SendResponse<Res>

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

open fun <Req, Res> send(request: Request<Req, Res>, @Nullable delay: @Nullable Duration): SendResponse<Res>

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

sendAsync

open fun <Req, Res> sendAsync(request: Request<Req, Res>): CompletableFuture<SendResponse<Res>>

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

Future version of send

service

@ApiStatus.Experimental

open fun <SVC> service(clazz: Class<SVC>): SVC

EXPERIMENTAL API: Simple API to invoke a Restate service from the ingress.

serviceHandle

@ApiStatus.Experimental

open fun <SVC> serviceHandle(clazz: Class<SVC>): ClientServiceHandle<SVC>

EXPERIMENTAL API: Advanced API to invoke a Restate service from the ingress with full control.

submit

open fun <Req, Res> submit(request: WorkflowRequest<Req, Res>): SendResponse<Res>

Submit a workflow.

open fun <Req, Res> submit(request: WorkflowRequest<Req, Res>, @Nullable delay: @Nullable Duration): SendResponse<Res>

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

submitAsync

open fun <Req, Res> submitAsync(request: WorkflowRequest<Req, Res>): CompletableFuture<SendResponse<Res>>

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

Future version of submit

virtualObject

@ApiStatus.Experimental

open fun <SVC> virtualObject(clazz: Class<SVC>, key: String): SVC

EXPERIMENTAL API: Simple API to invoke a Restate Virtual Object from the ingress.

virtualObjectHandle

@ApiStatus.Experimental

open fun <SVC> virtualObjectHandle(clazz: Class<SVC>, key: String): ClientServiceHandle<SVC>

EXPERIMENTAL API: Advanced API to invoke a Restate Virtual Object from the ingress with full control.

workflow

@ApiStatus.Experimental

open fun <SVC> workflow(clazz: Class<SVC>, key: String): SVC

EXPERIMENTAL API: Simple API to invoke a Restate Workflow from the ingress.

workflowHandle

@ApiStatus.Experimental

open fun <SVC> workflowHandle(clazz: Class<SVC>, key: String): ClientServiceHandle<SVC>

EXPERIMENTAL API: Advanced API to invoke a Restate Workflow from the ingress with full control.

open fun <Res> workflowHandle(workflowName: String, workflowId: String, clazz: Class<Res>): Client.WorkflowHandle<Res>

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

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