sdk-common/dev.restate.sdk.endpoint.definition/ServiceDefinition/Configurator

Configurator

class Configurator

Configurator for a ServiceDefinition.

Functions

Link copied to clipboard
@Nullable
open fun abortTimeout(): @Nullable Duration

open fun abortTimeout(@Nullable abortTimeout: @Nullable Duration): ServiceDefinition.Configurator
This timer guards against stalled service/handler invocations that are supposed to terminate.
Link copied to clipboard
Link copied to clipboard
open fun configureHandler(handlerName: String, configurator: Consumer<HandlerDefinition.Configurator>): ServiceDefinition.Configurator
Configure a specific handler of this service.
Link copied to clipboard
@Nullable
open fun documentation(): @Nullable String

open fun documentation(@Nullable documentation: @Nullable String): ServiceDefinition.Configurator
Documentation as shown in the UI, Admin REST API, and the generated OpenAPI documentation of this service.
Link copied to clipboard
@Nullable
open fun enableLazyState(): @Nullable Boolean

open fun enableLazyState(@Nullable enableLazyState: @Nullable Boolean): ServiceDefinition.Configurator
When set to true, lazy state will be enabled for all invocations to this service.
Link copied to clipboard
@Nullable
open fun idempotencyRetention(): @Nullable Duration

open fun idempotencyRetention(@Nullable idempotencyRetention: @Nullable Duration): ServiceDefinition.Configurator
The retention duration of idempotent requests to this service.
Link copied to clipboard
@Nullable
open fun inactivityTimeout(): @Nullable Duration

open fun inactivityTimeout(@Nullable inactivityTimeout: @Nullable Duration): ServiceDefinition.Configurator
This timer guards against stalled invocations.
Link copied to clipboard
@Nullable
open fun ingressPrivate(): @Nullable Boolean

open fun ingressPrivate(@Nullable ingressPrivate: @Nullable Boolean): ServiceDefinition.Configurator
When set to true this service, with all its handlers, cannot be invoked from the restate-server HTTP and Kafka ingress, but only from other services.
Link copied to clipboard
@Nullable
open fun journalRetention(): @Nullable Duration

open fun journalRetention(@Nullable journalRetention: @Nullable Duration): ServiceDefinition.Configurator
The journal retention.
Link copied to clipboard
open fun metadata(): Map<String, String>

open fun metadata(metadata: Map<String, String>): ServiceDefinition.Configurator
Service metadata, as propagated in the Admin REST API.