Package dev.restate.sdk.endpoint.definition

Class HandlerDefinition<REQ,RES>

java.lang.Object

dev.restate.sdk.endpoint.definition.HandlerDefinition<REQ,RES>

public final class HandlerDefinition<REQ,RES>
extends Object

This class represents a Restate handler.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
HandlerDefinition<REQ,RES>	configure(Consumer<HandlerDefinition.Configurator> configurator)
boolean	equals(Object o)
@Nullable Duration	getAbortTimeout()
@Nullable String	getAcceptContentType()
@Nullable String	getDocumentation()
@Nullable Boolean	getEnableLazyState()
HandlerType	getHandlerType()
@Nullable Duration	getIdempotencyRetention()
@Nullable Duration	getInactivityTimeout()
@Nullable Boolean	getIngressPrivate()
@Nullable Duration	getJournalRetention()
Map<String,String>	getMetadata()
String	getName()
Serde<REQ>	getRequestSerde()
Serde<RES>	getResponseSerde()
HandlerRunner<REQ,RES>	getRunner()
@Nullable Duration	getWorkflowRetention()
int	hashCode()
static <REQ, RES> HandlerDefinition<REQ,RES>	of(String handler, HandlerType handlerType, Serde<REQ> requestSerde, Serde<RES> responseSerde, HandlerRunner<REQ,RES> runner)
HandlerDefinition<REQ,RES>	withAcceptContentType(String acceptContentType)
HandlerDefinition<REQ,RES>	withDocumentation(@Nullable String documentation)
HandlerDefinition<REQ,RES>	withMetadata(Map<String,String> metadata)

Methods inherited from class java.lang.Object

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

Method Details

getName

public String getName()

Returns:

handler name.

getHandlerType

public HandlerType getHandlerType()

Returns:

handler type.

getAcceptContentType

public @Nullable String getAcceptContentType()

Returns:

the acceptable content type when ingesting HTTP requests. Wildcards can be used, e.g. application / * or * / *.

getRequestSerde

public Serde<REQ> getRequestSerde()

Returns:

request Serde

getResponseSerde

public Serde<RES> getResponseSerde()

Returns:

response Serde

getDocumentation

public @Nullable String getDocumentation()

Returns:

handler documentation. When using the annotation processor, this will contain the javadoc of the annotated methods.

getMetadata

public Map<String,String> getMetadata()

Returns:

metadata, as shown in the Admin REST API.

getRunner

public HandlerRunner<REQ,RES> getRunner()

getInactivityTimeout

public @Nullable Duration getInactivityTimeout()

Returns:

the inactivity timeout applied to this handler.

See Also:

• HandlerDefinition.Configurator.inactivityTimeout(Duration)

getAbortTimeout

public @Nullable Duration getAbortTimeout()

Returns:

the abort timeout applied to this handler.

See Also:

• HandlerDefinition.Configurator.abortTimeout(Duration)

getIdempotencyRetention

public @Nullable Duration getIdempotencyRetention()

Returns:

the idempotency retention applied to this handler.

See Also:

• HandlerDefinition.Configurator.idempotencyRetention(Duration)

getWorkflowRetention

public @Nullable Duration getWorkflowRetention()

Returns:

the workflow retention applied to this handler.

See Also:

• HandlerDefinition.Configurator.workflowRetention(Duration)

getJournalRetention

public @Nullable Duration getJournalRetention()

Returns:

the journal retention applied to this handler.

See Also:

• HandlerDefinition.Configurator.journalRetention(Duration)

getIngressPrivate

public @Nullable Boolean getIngressPrivate()

Returns:

true if this handler cannot be invoked from the restate-server HTTP and Kafka ingress, but only from other services.

See Also:

• HandlerDefinition.Configurator.ingressPrivate(Boolean)

getEnableLazyState

public @Nullable Boolean getEnableLazyState()

Returns:

true if this handler will use lazy state.

See Also:

• HandlerDefinition.Configurator.enableLazyState(Boolean)

withAcceptContentType

public HandlerDefinition<REQ,RES> withAcceptContentType(String acceptContentType)

withDocumentation

public HandlerDefinition<REQ,RES> withDocumentation(@Nullable String documentation)

withMetadata

public HandlerDefinition<REQ,RES> withMetadata(Map<String,String> metadata)

configure

public HandlerDefinition<REQ,RES> configure(Consumer<HandlerDefinition.Configurator> configurator)

Returns:

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

of

public static <REQ,
RES> HandlerDefinition<REQ,RES> of(String handler,
 HandlerType handlerType,
 Serde<REQ> requestSerde,
 Serde<RES> responseSerde,
 HandlerRunner<REQ,RES> runner)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object