Package dev.restate.sdk.endpoint

Class Endpoint.Builder

java.lang.Object

dev.restate.sdk.endpoint.Endpoint.Builder

Enclosing class:

Endpoint

public static class Endpoint.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Endpoint.Builder	bind(ServiceDefinition serviceDefinition)	Add a manual ServiceDefinition to the endpoint.
Endpoint.Builder	bind(Object service)	Add a Restate service to the endpoint.
Endpoint.Builder	bind(Object service, HandlerRunner.Options options)	Like bind(Object), but allows to provide options for the handler runner.
Endpoint.Builder	bind(Object service, HandlerRunner.Options options, Consumer<ServiceDefinition.Configurator> configurator)	Same as bind(Object, HandlerRunner.Options) but allows to configure the ServiceDefinition before binding it.
Endpoint.Builder	bind(Object service, Consumer<ServiceDefinition.Configurator> configurator)	Same as bind(Object) but allows to configure the ServiceDefinition before binding it.
Endpoint	build()
Endpoint.Builder	enablePreviewContext()
io.opentelemetry.api.OpenTelemetry	getOpenTelemetry()
RequestIdentityVerifier	getRequestIdentityVerifier()
void	setOpenTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)	Same as withOpenTelemetry(OpenTelemetry).
void	setRequestIdentityVerifier(RequestIdentityVerifier requestIdentityVerifier)	Same as withRequestIdentityVerifier(RequestIdentityVerifier).
Endpoint.Builder	withOpenTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)	Set the OpenTelemetry implementation for tracing and metrics.
Endpoint.Builder	withRequestIdentityVerifier(RequestIdentityVerifier requestIdentityVerifier)	Set the request identity verifier for this endpoint.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

bind

public Endpoint.Builder bind(Object service)

Add a Restate service to the endpoint. This will automatically discover the generated factory based on the class name.

If you want to modify some of the service definition options, such as documentation, inactivity timeout, and so on, use bind(Object, Consumer) instead.

You can also manually instantiate the ServiceDefinition using bind(ServiceDefinition).

bind

public Endpoint.Builder bind(Object service,
 HandlerRunner.Options options)

Like bind(Object), but allows to provide options for the handler runner. This allows to configure for the Java API the executor where to run the handler code, or the Kotlin API the coroutine context.

Look at the respective documentations of the HandlerRunner class in the Java or in the Kotlin module.

If you want to modify some of the service definition options, such as documentation, inactivity timeout, and so on, use bind(Object, HandlerRunner.Options, Consumer) instead.

See Also:

• bind(Object)

bind

public Endpoint.Builder bind(Object service,
 Consumer<ServiceDefinition.Configurator> configurator)

Same as bind(Object) but allows to configure the ServiceDefinition before binding it.

 Endpoint endpoint = Endpoint
   .builder()
   .bind(
     new Counter(),
     // Configure the service
     s -> s.journalRetention(Duration.ofDays(1))
   )
   .build();
 

See Also:

• bind(Object)
• ServiceDefinition.Configurator

bind

public Endpoint.Builder bind(Object service,
 HandlerRunner.Options options,
 Consumer<ServiceDefinition.Configurator> configurator)

Same as bind(Object, HandlerRunner.Options) but allows to configure the ServiceDefinition before binding it.

See Also:

• bind(Object, HandlerRunner.Options)
• ServiceDefinition.Configurator

bind

public Endpoint.Builder bind(ServiceDefinition serviceDefinition)

Add a manual ServiceDefinition to the endpoint.

withOpenTelemetry

public Endpoint.Builder withOpenTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)

Set the OpenTelemetry implementation for tracing and metrics.

See Also:

• OpenTelemetry

setOpenTelemetry

public void setOpenTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)

Same as withOpenTelemetry(OpenTelemetry).

getOpenTelemetry

public io.opentelemetry.api.OpenTelemetry getOpenTelemetry()

Returns:

the configured OpenTelemetry

withRequestIdentityVerifier

public Endpoint.Builder withRequestIdentityVerifier(RequestIdentityVerifier requestIdentityVerifier)

Set the request identity verifier for this endpoint.

For the Restate implementation to use with Restate Cloud, check the module sdk-request-identity.

setRequestIdentityVerifier

public void setRequestIdentityVerifier(RequestIdentityVerifier requestIdentityVerifier)

Same as withRequestIdentityVerifier(RequestIdentityVerifier).

getRequestIdentityVerifier

public RequestIdentityVerifier getRequestIdentityVerifier()

Returns:

the configured request identity verifier

enablePreviewContext

public Endpoint.Builder enablePreviewContext()

build

public Endpoint build()