All Classes and Interfaces
Class
Description
You MUST NOT catch this exception.
Deprecated.
Define the acceptable content type.
Deprecated.
Deprecated.
Deprecated.
An
Awakeable is a special type of DurableFuture which can be arbitrarily
completed by another service, by addressing it with its Awakeable.id().This class represents a handle to an
Awakeable created in another service.Base client.
Base implementation of a Lambda handler to execute restate services
ByteBuddy-based proxy factory that supports both interfaces and concrete classes.
DurableFuture returned by a call to another service.This class represents a handle to an Awakeable.
Advanced API handle for invoking Restate services, virtual objects, or workflows from the ingress
(outside of a handler).
Deprecated.
Deprecated.
A single map entry.
A reference to an
ConcurrentReferenceHashMap.Entry contained in the map.Various reference types supported by this map.
The types of restructuring that can be performed.
Deprecated.
Deprecated, for removal: This API element is subject to removal in a future version.
Expectation configuration for
FakeContext.Deprecated.
Define the custom
SerdeFactory to use for this service/virtual object/workflow.
How the server deduplicates the records of a stream.
This class is used to autoload either JacksonSerdeFactory or KotlinxSerializationSerdeFactory in
the client.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Service discovery protocol version.
A
DurableFuture allows to await an asynchronous result.A
DurablePromise is a durable, distributed version of a CompletableFuture.This class represents a handle to an
DurablePromise created in another handler.This class holds information about durable promise's name and its type tag to be used for
serializing and deserializing it.
Deprecated.
Add this annotation in your application class next to the
SpringBootApplication annotation to enable the Restate
Spring features.Restate endpoint, encapsulating the configured services, together with additional options.
Endpoint
Compression used when the endpoint is a Lambda.
ProtocolMode
Interface to abstract setting the logging context variables.
An error frame.
An error frame.
Deprecated.
Protobuf enum
dev.restate.ingress.ingestion.v1.ErrorKindSends invocations to Restate with exactly-once deduplication.
Defines a method as an exclusive handler, as opposed to
Shared handlers.Fake
Context, see ContextExpectations for more details.Fake Restate environment for testing handlers using the new reflection API.
SPI default using
GlobalOpenTelemetry.Annotate a method as Restate handler.
Handler
RetryPolicyOnMaxAttempts
HandlerType
Internal interface to access Restate functionalities.
Result of
HandlerContext.await(UnresolvedFuture).The invocation was aborted, e.g.
One single of the awaited tree completed.
The invocation was cancelled: the awaited tree should be completed as cancelled.
Opaque handle to the result of an operation, returned by the
HandlerContext operations,
and used to build the HandlerContext.UnresolvedFuture.Single nodes of a future tree.Result of an operation.
Node of a future tree, awaited with
HandlerContext.await(UnresolvedFuture).Completes when all children succeed, or fails as soon as one child fails.
Completes as soon as any child completes, either with success or failure.
Node combining several children.
Node mapping the result of the
upstream node.Node completed by the result of its
HandlerContext.Handle, with no children.This class represents a Restate handler.
Configurator for a
HandlerDefinition.Wraps a single handler invocation attempt.
Per-invocation context exposed to a
HandlerInterceptor.Factory for
HandlerInterceptor.Advances the interceptor chain.
Deprecated.
Deprecated.
This class encapsulates the inputs to a handler.
Adapter class for
HandlerRunner to use the Java API.Marker interface of runner options.
HandlerRunner options, to configure the executor to use to run your services, and the
interceptors.Abstraction for headers map.
Deprecated.
Vert.x HttpServer handler adapter for
Endpoint.
An IngestionDefaults message defines the default values applied to all
subsequent records in the stream.
An IngestionDefaults message defines the default values applied to all
subsequent records in the stream.
Protobuf type
dev.restate.ingress.ingestion.v1.IngestionInvocationProtobuf type
dev.restate.ingress.ingestion.v1.IngestionInvocationProtobuf type
dev.restate.ingress.ingestion.v1.IngestionRequestProtobuf type
dev.restate.ingress.ingestion.v1.IngestionRequestProtobuf type
dev.restate.ingress.ingestion.v1.IngestionResponseProtobuf type
dev.restate.ingress.ingestion.v1.IngestionResponse
Required.
Required.
A stub to allow clients to do limited synchronous rpc calls to service IngestionSvc.
A stub to allow clients to do synchronous rpc calls to service IngestionSvc.
A stub to allow clients to do ListenableFuture-style rpc calls to service IngestionSvc.
Base class for the server implementation of the service IngestionSvc.
A stub to allow clients to do asynchronous rpc calls to service IngestionSvc.
InputPayload
Entry point for producing invocations to Restate ingress over the ingestion API.
Builder for
IntegrationClient.The failure that pending producer futures complete with when the ingestion stream errors or
closes.
Classification of an ingestion stream failure.
A single invocation to send through a
Producer / ExactlyOnceProducer.Deprecated.
Handle to interact with an invocation.
This represents a stable identifier created by Restate for this invocation.
Invocation metadata.
Retry policy used by Restate when retrying failed handler invocations.
Behavior when retry policy reaches
InvocationRetryPolicy.maxAttempts() attempts.This class implements
SerdeFactory using Jackson's ObjectMapper.Deprecated, for removal: This API element is subject to removal in a future version.
This will be removed in the next release, please check the individual methods for
more details.
Serde implementations for Jackson.Serialize/Deserialize the annotated element as Json
Deprecated.
Deprecated, for removal: This API element is subject to removal in a future version.
For primitive types, simply use the overloads of the
Context/StateKey/DurablePromiseKey methods
accepting Class, for example ctx.run(String.class, myClosure) or
ctx.awakeable(Integer.TYPE) or StateKey.of("key", String.class)Restate Lambda Endpoint.
Legacy pure-Java
StateMachine, used on JDK < 23 or when the native shared-core library
is unavailable/disabled.Deprecated.
Deprecated.
Deprecated.
Deprecated.
Custom metadata of this handler definition.
Custom metadata of this service definition.
Shared helpers for building Micrometer observations that mirror the spans produced by
sdk-interceptor-opentelemetry: same span names and the same attribute set (
restate.invocation.id, restate.invocation.target, restate.run.name).Micrometer Observation interceptor factory for Java handlers.
RunContextPropagator based on Micrometer's ContextSnapshotFactory.Deprecated.
Deprecated.
Name of the service/handler for Restate.
Deprecated, for removal: This API element is subject to removal in a future version.
The
Context-parameter programming model is superseded by the reflection-based
API.Deprecated.
Standard OpenTelemetry attribute keys used by the Restate interceptors.
OpenTelemetry interceptor factory for Java handlers.
RunContextPropagator based on the OpenTelemetry Context.This class is similar to
Optional, but allows null values.OutputPayload
Deprecated.
Payload codec.
Preview of new context features.
Sends invocations to Restate with at-least-once delivery.
Common producer offsets, acknowledgement, flushing, and lifecycle operations.
Thrown by
send when the producer cannot admit an invocation within the configured ProducerOptions.maxBlockTime(), or the thread is interrupted while waiting.Configuration shared by at-least-once and exactly-once producers.
Builder for
ProducerOptions.
Completable: Yes
Fallible: Yes
Type: 0x0400 + 12
Completable: Yes
Fallible: Yes
Type: 0x0400 + 12
Notification for AttachInvocationCommandMessage
Type: 0x8000 + 12
Notification for AttachInvocationCommandMessage
Type: 0x8000 + 12
Protobuf enum
dev.restate.service.protocol.BuiltInSignal
Completable: Yes (two notifications: one with invocation id, then one with the actual result)
Fallible: Yes
Type: 0x0400 + D
Completable: Yes (two notifications: one with invocation id, then one with the actual result)
Fallible: Yes
Type: 0x0400 + D
Notification for CallCommandMessage
Type: 0x8000 + D
Notification for CallCommandMessage
Type: 0x8000 + D
Notification for CallCommandMessage and OneWayCallCommandMessage
Type: 0x8000 + E
Notification for CallCommandMessage and OneWayCallCommandMessage
Type: 0x8000 + E
Completable: No
Fallible: No
Type: 0x0400 + 5
Completable: No
Fallible: No
Type: 0x0400 + 5
Completable: No
Fallible: No
Type: 0x0400 + 4
Completable: No
Fallible: No
Type: 0x0400 + 4
Type: 0x0000 + 4
Type: 0x0000 + 4
We have this for backward compatibility, because we need to parse both old and new awakeable id.
We have this for backward compatibility, because we need to parse both old and new awakeable id.
Completable: Yes
Fallible: No
Type: 0x0400 + B
Completable: Yes
Fallible: No
Type: 0x0400 + B
Notification for CompletePromiseCommandMessage
Type: 0x8000 + B
Notification for CompletePromiseCommandMessage
Type: 0x8000 + B
Type: 0x0000 + 3
Implementations MUST send this message when the invocation lifecycle ends.
Type: 0x0000 + 3
Implementations MUST send this message when the invocation lifecycle ends.
Type: 0x0000 + 2
Type: 0x0000 + 2
This failure object carries user visible errors,
e.g.
This failure object carries user visible errors,
e.g.
Protobuf type
dev.restate.service.protocol.FailureMetadataProtobuf type
dev.restate.service.protocol.FailureMetadata
Completable: No
Fallible: No
Type: 0x0400 + 7
Completable: No
Fallible: No
Type: 0x0400 + 7
Completable: No
Fallible: No
Type: 0x0400 + 8
Completable: No
Fallible: No
Type: 0x0400 + 8
Completable: Yes
Fallible: Yes
Type: 0x0400 + 13
Completable: Yes
Fallible: Yes
Type: 0x0400 + 13
Notification for GetInvocationOutputCommandMessage
Type: 0x8000 + 13
Notification for GetInvocationOutputCommandMessage
Type: 0x8000 + 13
Completable: Yes
Fallible: No
Type: 0x0400 + 2
Completable: Yes
Fallible: No
Type: 0x0400 + 2
Notification for GetLazyStateCommandMessage
Type: 0x8000 + 2
Notification for GetLazyStateCommandMessage
Type: 0x8000 + 2
Completable: Yes
Fallible: No
Type: 0x0400 + 6
Completable: Yes
Fallible: No
Type: 0x0400 + 6
Notification for GetLazyStateKeysCommandMessage
Type: 0x8000 + 6
Notification for GetLazyStateKeysCommandMessage
Type: 0x8000 + 6
Completable: Yes
Fallible: No
Type: 0x0400 + 9
Completable: Yes
Fallible: No
Type: 0x0400 + 9
Notification for GetPromiseCommandMessage
Type: 0x8000 + 9
Notification for GetPromiseCommandMessage
Type: 0x8000 + 9
Protobuf type
dev.restate.service.protocol.HeaderProtobuf type
dev.restate.service.protocol.HeaderProtobuf type
dev.restate.service.protocol.IdempotentRequestTargetProtobuf type
dev.restate.service.protocol.IdempotentRequestTarget
Completable: No
Fallible: No
Type: 0x0400 + 0
Completable: No
Fallible: No
Type: 0x0400 + 0
A notification message follows the following duck-type:
A notification message follows the following duck-type:
Completable: Yes (only one notification with invocation id)
Fallible: Yes
Type: 0x0400 + E
Completable: Yes (only one notification with invocation id)
Fallible: Yes
Type: 0x0400 + E
Completable: No
Fallible: No
Type: 0x0400 + 1
Completable: No
Fallible: No
Type: 0x0400 + 1
Completable: Yes
Fallible: No
Type: 0x0400 + A
Completable: Yes
Fallible: No
Type: 0x0400 + A
Notification for PeekPromiseCommandMessage
Type: 0x8000 + A
Notification for PeekPromiseCommandMessage
Type: 0x8000 + A
This is a special control message to propose ctx.run completions to the runtime.
This is a special control message to propose ctx.run completions to the runtime.
Proposals for Run completions are sent through ProposeRunCompletionMessage
Completable: Yes
Fallible: No
Type: 0x0400 + 11
Proposals for Run completions are sent through ProposeRunCompletionMessage
Completable: Yes
Fallible: No
Type: 0x0400 + 11
Notification for RunCommandMessage
Type: 0x8000 + 11
Notification for RunCommandMessage
Type: 0x8000 + 11
Completable: No
Fallible: Yes
Type: 0x04000 + 10
Completable: No
Fallible: Yes
Type: 0x04000 + 10
Service protocol version.
Completable: No
Fallible: No
Type: 0x0400 + 3
Completable: No
Fallible: No
Type: 0x0400 + 3
Notification message for signals
Type: 0xFBFF
Notification message for signals
Type: 0xFBFF
Completable: Yes
Fallible: No
Type: 0x0400 + C
Completable: Yes
Fallible: No
Type: 0x0400 + C
Notification for SleepCommandMessage
Type: 0x8000 + C
Notification for SleepCommandMessage
Type: 0x8000 + C
Type: 0x0000 + 0
Type: 0x0000 + 0
Protobuf type
dev.restate.service.protocol.StartMessage.StateEntryProtobuf type
dev.restate.service.protocol.StartMessage.StateEntryProtobuf type
dev.restate.service.protocol.StateKeysProtobuf type
dev.restate.service.protocol.StateKeys
Type: 0x0000 + 1
Implementations MUST send this message when suspending an invocation.
Type: 0x0000 + 1
Implementations MUST send this message when suspending an invocation.
Protobuf type
dev.restate.service.protocol.ValueProtobuf type
dev.restate.service.protocol.ValueProtobuf type
dev.restate.service.protocol.VoidProtobuf type
dev.restate.service.protocol.VoidProtobuf type
dev.restate.service.protocol.WorkflowTargetProtobuf type
dev.restate.service.protocol.WorkflowTargetDeprecated.
Skip serialization/deserialization of the annotated element.
Callback interface invoked on each field in the hierarchy.
Callback optionally used to filter fields to be operated on by a field callback.
Record containing handler information extracted from annotations.
Action to take on each method.
Callback optionally used to filter methods to be operated on by a method callback.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Interface encapsulating request parameters.
Options for requests to Restate services.
Interface to verify requests.
Resolved handler for an invocation.
This class exposes the Restate functionalities to Restate services using the reflection-based
API.
Interface to interact with this Virtual Object/Workflow state.
Deprecated.
The code-generated admin client (the
dev.restate.admin package) is
deprecated.Inject a
Client to interact with the deployed runtime.Configuration for Restate's
Client, to send requests to Restate services.Add this annotation to a class annotated with Restate's
Service or VirtualObject or Workflow to bind them to the Restate HTTP Endpoint.Configuration properties for a Restate service/component.
Properties for configuring Restate services.
Log4j2
ContextDataProvider inferring context from HandlerRunner.HANDLER_CONTEXT_THREAD_LOCAL.Configuration properties for a Restate handler.
Restate HTTP Endpoint serving
EndpointDeprecated, for removal: This API element is subject to removal in a future version.
Use
RestateHttpServer in combination with Endpoint instead.Endpoint builder for a Restate HTTP Endpoint using Vert.x, to serve Restate services.
Subclass of
Random inherently predictable, seeded on the InvocationId, which is
not secret.Manual runner for the Restate test infra, starting the Restate server container together with the
provided services and automatically registering them.
Builder for
RestateRunner.Proxy annotation for
Service, to avoid naming clashes with Spring's built in annotationsDeprecated.
Use
RestateComponentProperties instead, or directly define the configuration
in your application.properties file.Annotation to enable the Restate extension for JUnit 5.
Proxy annotation for
VirtualObject.Proxy annotation for
Workflow.Retry policy configuration.
Configuration properties for Restate's retry policy when retrying failed handler invocations.
Behavior when retry policy reaches
RetryPolicyProperties.getMaxAttempts() attempts.Deprecated.
Deprecated.
Deprecated.
Propagates thread-local state from the thread running the handler code to the thread executing a
Restate.run(String, Class, ThrowingSupplier) closure.Thread-local state captured by
RunContextPropagator.capture().Wraps the execution of a
Restate.run(String, Class, ThrowingSupplier) closure.Per-
ctx.run call context exposed to a RunInterceptor.Factory for
RunInterceptor.Advances the interceptor chain.
PREVIEW: A context for making RPC calls within a specific scope.
PREVIEW: A client for making RPC calls within a specific scope.
Select lets you await concurrently for multiple
DurableFutures to complete, and for the
first one to complete, either return its value directly or map it.Result of a non-blocking producer admission attempt.
The invocation was accepted; the future completes on durable acknowledgement.
The invocation was not accepted because the producer was backpressured.
Send result metadata.
Interface defining serialization and deserialization of concrete types.
Schema to be serialized using internal Jackson mapper.
Schema already serialized to String.
This factory creates
Serde that are used in various places of the SDK, notably:
To deserialize handler's input and deserialize the output
To serialize and deserialize state, awakeables, promises and so on
When using the Java APIs, a Jackson based implementation is used by default, see JacksonSerdeFactory in sdk-serde-jackson module.Combines a
SerdeFactory and a PayloadCodec: resolves the Serde from the
TypeTag, then serializes and encodes, or decodes and deserializes, the values.Deprecated.
Deprecated.
Annotation to define a class/interface as Restate Service.
Service
RetryPolicyOnMaxAttempts
ServiceType
Deprecated.
This class represents a Restate service.
Configurator for a
ServiceDefinition.Advanced API handle for invoking Restate services, virtual objects, or workflows with full
control.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Defines a method as a Shared handler.
Deprecated, for removal: This API element is subject to removal in a future version.
The
Context-parameter programming model is superseded by the reflection-based
API.Deprecated, for removal: This API element is subject to removal in a future version.
The
Context-parameter programming model is superseded by the reflection-based
API.Handle to resolve or reject a named signal on a target invocation.
Wrapper type for byte slices.
This class holds information about state's name and its type tag to be used for serializing and
deserializing it.
Canonical state-machine contract driving a single Restate invocation.
Deprecated.
Deprecated.
Represents an invocation target.
When thrown in a Restate service method, it will complete the invocation with an error.
Like
BiConsumer but can throw checked exceptions.Like
BiFunction but can throw checked exceptions.Like
Consumer but can throw checked exceptions.Like
Function but can throw checked exceptions.Like
Runnable but can throw checked exceptions.Like
Supplier but can throw checked exceptions.This generic abstract class is used for obtaining full generics type information by sub-classing.
This interface is used by the serialization stack to carry types runtime information.
Accessors to walk the future tree passed to
StateMachine.doAwait(UnresolvedFuture).State machine node type.
Deprecated.
Deprecated.
Deprecated.
Generated at build time by the `generateVersionClass` Gradle task.
Deprecated.
Deprecated.
Annotation to define a class/interface as Restate VirtualObject.
Application-layer flow-control message.
Application-layer flow-control message.
Annotation to define a class/interface as Restate Workflow.
Deprecated, for removal: This API element is subject to removal in a future version.
The
Context-parameter programming model is superseded by the reflection-based
API.Workflow handler request.
Workflow handler request builder.
Context-parameter programming model is superseded by the reflection-based API.