Struct ServiceOptions

pub struct ServiceOptions { /* private fields */ }

Various configuration options that can be provided when binding a service

Implementations

impl ServiceOptions

pub fn new() -> Self

pub fn inactivity_timeout(self, timeout: Duration) -> Self

This timer guards against stalled invocations. Once it expires, Restate triggers a graceful termination by asking the invocation to suspend (which preserves intermediate progress).

The abort_timeout is used to abort the invocation, in case it doesn’t react to the request to suspend.

This overrides the default inactivity timeout configured in the restate-server for all invocations to this service.

pub fn abort_timeout(self, timeout: Duration) -> Self

This timer guards against stalled service/handler invocations that are supposed to terminate. The abort timeout is started after the inactivity_timeout has expired and the service/handler invocation has been asked to gracefully terminate. Once the timer expires, it will abort the service/handler invocation.

This timer potentially interrupts user code. If the user code needs longer to gracefully terminate, then this value needs to be set accordingly.

This overrides the default abort timeout configured in the restate-server for all invocations to this service.

pub fn idempotency_retention(self, retention: Duration) -> Self

The retention duration of idempotent requests to this service.

pub fn journal_retention(self, retention: Duration) -> Self

The journal retention. When set, this applies to all requests to all handlers of this service.

In case the request has an idempotency key, the idempotency_retention caps the journal retention time.

pub fn enable_lazy_state(self, enable: bool) -> Self

When set to true, lazy state will be enabled for all invocations to this service. This is relevant only for workflows and virtual objects.

pub fn ingress_private(self, private: bool) -> Self

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.

pub fn metadata(self, key: impl Into<String>, value: impl Into<String>) -> Self

Custom metadata of this service definition. This metadata is shown on the Admin API when querying the service definition.

pub fn handler( self, handler_name: impl Into<String>, options: HandlerOptions, ) -> Self

Handler-specific options.

Note: If you provide a handler name for a non-existing handler, binding the service will panic!.

Trait Implementations

impl Clone for ServiceOptions

fn clone(&self) -> ServiceOptions

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ServiceOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ServiceOptions

fn default() -> ServiceOptions

Returns the “default value” for a type.