client-kotlin/dev.restate.client.kotlin

Package-level declarations

Types

KClientRequest

interface KClientRequest<Req, Res> : Request<Req, Res>

Kotlin-idiomatic request for invoking Restate services from an ingress client.

KClientRequestBuilder

class KClientRequestBuilder<SVC : Any>

Builder for creating type-safe requests.

ScopedKotlinClient

@ApiStatus.Experimental

class ~~ScopedKotlinClient~~

PREVIEW: A client for making RPC calls within a specific scope.

Properties

headers

val ResponseHead.headers: ResponseHead.Headers

response

val <Res> Response<Res>.response: Res

sendStatus

val <Res> SendResponse<Res>.sendStatus: SendResponse.SendStatus

status

val ResponseHead.status: Int

Functions

attachSuspend

suspend fun <T> Client.IdempotentInvocationHandle<T>.attachSuspend(options: RequestOptions = RequestOptions.DEFAULT): Response<T>

Suspend version of Client.IdempotentInvocationHandle.attach.

suspend fun <T> Client.InvocationHandle<T>.attachSuspend(options: RequestOptions = RequestOptions.DEFAULT): Response<T>

Suspend version of Client.InvocationHandle.attach.

suspend fun <T> Client.WorkflowHandle<T>.attachSuspend(options: RequestOptions = RequestOptions.DEFAULT): Response<T>

Suspend version of Client.WorkflowHandle.attach.

call

suspend fun <Req, Res> Request<Req, Res>.call(client: Client): Response<Res>

Shorthand for callSuspend

callSuspend

suspend fun <Req, Res> Client.callSuspend(request: Request<Req, Res>): Response<Res>

Call a service and wait for the response.

getOutputSuspend

suspend fun <T> Client.IdempotentInvocationHandle<T>.getOutputSuspend(options: RequestOptions = RequestOptions.DEFAULT): Response<Output<T>>

Suspend version of Client.IdempotentInvocationHandle.getOutput.

suspend fun <T> Client.InvocationHandle<T>.getOutputSuspend(options: RequestOptions = RequestOptions.DEFAULT): Response<Output<T>>

Suspend version of Client.InvocationHandle.getOutput.

suspend fun <T> Client.WorkflowHandle<T>.getOutputSuspend(options: RequestOptions = RequestOptions.DEFAULT): Response<Output<T>>

Suspend version of Client.WorkflowHandle.getOutput.

idempotentInvocationHandle

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

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

invocationHandle

inline fun <Res> Client.invocationHandle(invocationId: String): Client.InvocationHandle<Res>

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

rejectSuspend

suspend fun Client.AwakeableHandle.rejectSuspend(reason: String, options: RequestOptions = RequestOptions.DEFAULT): Response<Void>

Complete with failure the Awakeable.

requestOptions

fun requestOptions(init: RequestOptions.Builder.() -> Unit): RequestOptions

Request options builder function

resolveSuspend

inline suspend fun <T : Any> Client.AwakeableHandle.resolveSuspend(payload: T, options: RequestOptions = RequestOptions.DEFAULT): Response<Void>

suspend fun <T : Any> Client.AwakeableHandle.resolveSuspend(typeTag: TypeTag<T>, payload: T, options: RequestOptions = RequestOptions.DEFAULT): Response<Void>

Complete with success the Awakeable.

scope

@ApiStatus.Experimental

fun Client.~~scope~~(scopeKey: String): ScopedKotlinClient

PREVIEW: Returns a ScopedKotlinClient that routes all outgoing calls within the given scope.

send

suspend fun <Req, Res> Request<Req, Res>.send(client: Client, delay: Duration? = null): SendResponse<Res>

Shorthand for sendSuspend

sendSuspend

suspend fun <Req, Res> Client.sendSuspend(request: Request<Req, Res>, delay: Duration? = null): SendResponse<Res>

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

service

inline fun <SVC : Any> Client.service(): SVC

Create a proxy client for a Restate service.

@ApiStatus.Experimental

inline fun <SVC : Any> ScopedClient.service(): SVC

PREVIEW: Create a proxy client for a Restate service within the given scope.

submit

suspend fun <Req, Res> WorkflowRequest<Req, Res>.submit(client: Client, delay: Duration? = null): SendResponse<Res>

Shorthand for submitSuspend

submitSuspend

suspend fun <Req, Res> Client.submitSuspend(request: WorkflowRequest<Req, Res>, delay: Duration? = null): SendResponse<Res>

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

toService

inline fun <SVC : Any> Client.toService(): KClientRequestBuilder<SVC>

Create a builder for invoking a Restate service.

@ApiStatus.Experimental

inline fun <SVC : Any> ScopedClient.toService(): KClientRequestBuilder<SVC>

PREVIEW: Create a builder for invoking a Restate service within the given scope.

toVirtualObject

inline fun <SVC : Any> Client.toVirtualObject(key: String): KClientRequestBuilder<SVC>

Create a builder for invoking a Restate virtual object.

@ApiStatus.Experimental

inline fun <SVC : Any> ScopedClient.toVirtualObject(key: String): KClientRequestBuilder<SVC>

PREVIEW: Create a builder for invoking a Restate virtual object within the given scope.

toWorkflow

inline fun <SVC : Any> Client.toWorkflow(key: String): KClientRequestBuilder<SVC>

Create a builder for invoking a Restate workflow.

@ApiStatus.Experimental

inline fun <SVC : Any> ScopedClient.toWorkflow(key: String): KClientRequestBuilder<SVC>

PREVIEW: Create a builder for invoking a Restate workflow within the given scope.

virtualObject

inline fun <SVC : Any> Client.virtualObject(key: String): SVC

Create a proxy client for a Restate virtual object.

@ApiStatus.Experimental

inline fun <SVC : Any> ScopedClient.virtualObject(key: String): SVC

PREVIEW: Create a proxy client for a Restate virtual object within the given scope.

workflow

inline fun <SVC : Any> Client.workflow(key: String): SVC

Create a proxy client for a Restate workflow.

@ApiStatus.Experimental

inline fun <SVC : Any> ScopedClient.workflow(key: String): SVC

PREVIEW: Create a proxy client for a Restate workflow within the given scope.

workflowHandle

inline fun <Res> Client.workflowHandle(workflowName: String, workflowId: String): Client.WorkflowHandle<Res>

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