common/dev.restate.common/RequestBuilder

RequestBuilder

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

Options for requests to Restate services.

Inheritors

WorkflowRequestBuilder

Functions

build

abstract fun build(): Request<Req, Res>

getHeaders

@Nullable

abstract fun getHeaders(): @Nullable Map<String, String>

getIdempotencyKey

@Nullable

abstract fun getIdempotencyKey(): @Nullable String

getLimitKey

@ApiStatus.Experimental

@Nullable

abstract fun getLimitKey(): @Nullable String

PREVIEW: Limit key to use within the scope.

getRequest

abstract fun getRequest(): Req

getRequestTypeTag

abstract fun getRequestTypeTag(): TypeTag<Req>

getResponseTypeTag

abstract fun getResponseTypeTag(): TypeTag<Res>

getTarget

abstract fun getTarget(): Target

header

abstract fun header(key: String, value: String): RequestBuilder<Req, Res>

Append this header to the list of configured headers.

headers

abstract fun headers(@Nullable newHeaders: @Nullable Map<String, String>): RequestBuilder<Req, Res>

Append the given header map to the list of headers.

idempotencyKey

abstract fun idempotencyKey(@Nullable idempotencyKey: @Nullable String): RequestBuilder<Req, Res>

limitKey

@ApiStatus.Experimental

abstract fun limitKey(@Nullable limitKey: @Nullable String): RequestBuilder<Req, Res>

PREVIEW: Limit key to use within the scope.

open fun of(target: Target, request: Array<Byte>): RequestBuilder<Array<Byte>, Array<Byte>>

Create a new RequestBuilder for the given Target and request byte array.

open fun <Req, Res> of(target: Target, reqTypeTag: TypeTag<Req>, resTypeTag: TypeTag<Res>, request: Req): RequestBuilder<Req, Res>

Create a new RequestBuilder for the given Target, request and response TypeTag and request object.

setHeaders

abstract fun setHeaders(@Nullable headers: @Nullable Map<String, String>): RequestBuilder<Req, Res>

setIdempotencyKey

abstract fun setIdempotencyKey(@Nullable idempotencyKey: @Nullable String): RequestBuilder<Req, Res>

setLimitKey

@ApiStatus.Experimental

abstract fun setLimitKey(@Nullable limitKey: @Nullable String): RequestBuilder<Req, Res>

PREVIEW.

toBuilder

abstract fun toBuilder(): RequestBuilder<Req, Res>