Package dev.restate.sdk.endpoint.definition

Class ServiceDefinition

java.lang.Object

dev.restate.sdk.endpoint.definition.ServiceDefinition

public final class ServiceDefinition
extends Object

This class represents a Restate service.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ServiceDefinition.Configurator	Configurator for a ServiceDefinition.

Method Summary

Modifier and Type	Method	Description
ServiceDefinition	configure(Consumer<ServiceDefinition.Configurator> configurator)
boolean	equals(Object o)
@Nullable Duration	getAbortTimeout()
@Nullable String	getDocumentation()
@Nullable Boolean	getEnableLazyState()
@Nullable HandlerDefinition<?,?>	getHandler(String name)
Collection<HandlerDefinition<?,?>>	getHandlers()
@Nullable Duration	getIdempotencyRetention()
@Nullable Duration	getInactivityTimeout()
@Nullable Boolean	getIngressPrivate()
@Nullable Duration	getJournalRetention()
Map<String,String>	getMetadata()
String	getServiceName()
ServiceType	getServiceType()
int	hashCode()
static ServiceDefinition	of(String name, ServiceType ty, Collection<HandlerDefinition<?,?>> handlers)
ServiceDefinition	withDocumentation(@Nullable String documentation)
ServiceDefinition	withMetadata(Map<String,String> metadata)

Methods inherited from class java.lang.Object

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

Method Details

getServiceName

public String getServiceName()

Returns:

service name.

getServiceType

public ServiceType getServiceType()

Returns:

service type.

getHandlers

public Collection<HandlerDefinition<?,?>> getHandlers()

Returns:

handlers.

getHandler

public @Nullable HandlerDefinition<?,?> getHandler(String name)

Returns:

a specific handler.

getDocumentation

public @Nullable String getDocumentation()

Returns:

service documentation. When using the annotation processor, this will contain the javadoc of the annotated service class or interface.

getMetadata

public Map<String,String> getMetadata()

Returns:

metadata, as shown in the Admin REST API.

getInactivityTimeout

public @Nullable Duration getInactivityTimeout()

Returns:

the inactivity timeout applied to all handlers of this service.

See Also:

• ServiceDefinition.Configurator.inactivityTimeout(Duration)

getAbortTimeout

public @Nullable Duration getAbortTimeout()

Returns:

the abort timeout applied to all handlers of this service.

See Also:

• ServiceDefinition.Configurator.abortTimeout(Duration)

getIdempotencyRetention

public @Nullable Duration getIdempotencyRetention()

Returns:

the idempotency retention applied to all handlers of this service.

See Also:

• ServiceDefinition.Configurator.idempotencyRetention(Duration)

getJournalRetention

public @Nullable Duration getJournalRetention()

Returns:

the journal retention applied to all handlers of this service.

See Also:

• ServiceDefinition.Configurator.journalRetention(Duration)

getIngressPrivate

public @Nullable Boolean getIngressPrivate()

Returns:

true if the service, with all its handlers, cannot be invoked from the restate-server HTTP and Kafka ingress, but only from other services.

See Also:

• ServiceDefinition.Configurator.ingressPrivate(Boolean)

getEnableLazyState

public @Nullable Boolean getEnableLazyState()

Returns:

true if the service, with all its handlers, will use lazy state.

See Also:

• ServiceDefinition.Configurator.enableLazyState(Boolean)

withDocumentation

public ServiceDefinition withDocumentation(@Nullable String documentation)

withMetadata

public ServiceDefinition withMetadata(Map<String,String> metadata)

configure

public ServiceDefinition configure(Consumer<ServiceDefinition.Configurator> configurator)

Returns:

a copy of this ServiceDefinition, configured with the ServiceDefinition.Configurator.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

of

public static ServiceDefinition of(String name,
 ServiceType ty,
 Collection<HandlerDefinition<?,?>> handlers)