Interface Invocation

All Superinterfaces:

InvocationMetadata

@Experimental
public sealed interface Invocation
extends InvocationMetadata

A single invocation to send through a Producer / ExactlyOnceProducer.

Instances are created via create().

Passing null to a setter clears that field. Optional getters return null when the corresponding field is not set.

Method Summary

Modifier and Type	Method	Description
static Invocation	create()	Create a standalone invocation, not bound to any producer, to fill in and send.
byte[]	getBody()
@Nullable String	getIdempotencyKey()
@Nullable Instant	getInvokeTime()
@Nullable String	getTraceparent()
@Nullable String	getTracestate()
Invocation	putHeader(String key, String value)	Add or replace a single header.
Invocation	setBody(byte @Nullable [] body)	The invocation payload.
Invocation	setHandlerName(@Nullable String handlerName)	Target handler name.
Invocation	setHeaders(@Nullable Map<String,String> headers)	Replace the whole header map.
Invocation	setIdempotencyKey(@Nullable String idempotencyKey)	Idempotency key used by Restate to deduplicate the invocation.
Invocation	setInvokeTime(@Nullable Instant invokeTime)	Schedule the invocation at an absolute time.
Invocation	setKey(@Nullable String key)	Target key (required when the target is a Virtual Object or Workflow).
Invocation	setLimitKey(@Nullable String limitKey)	Rate/concurrency limit key.
Invocation	setScope(@Nullable String scope)	Scope.
Invocation	setServiceName(@Nullable String serviceName)	Target service name.
Invocation	setTraceparent(@Nullable String traceparent)	W3C traceparent.
Invocation	setTracestate(@Nullable String tracestate)	W3C tracestate.

Methods inherited from interface InvocationMetadata

getHandlerName, getHeaders, getKey, getLimitKey, getScope, getServiceName

Method Details

create

static Invocation create()

Create a standalone invocation, not bound to any producer, to fill in and send.

setBody

Invocation setBody(byte @Nullable [] body)

The invocation payload.

getBody

byte[] getBody()

setInvokeTime

Invocation setInvokeTime(@Nullable Instant invokeTime)

Schedule the invocation at an absolute time.

getInvokeTime

@Nullable Instant getInvokeTime()

setTraceparent

Invocation setTraceparent(@Nullable String traceparent)

W3C traceparent.

getTraceparent

@Nullable String getTraceparent()

setTracestate

Invocation setTracestate(@Nullable String tracestate)

W3C tracestate.

getTracestate

@Nullable String getTracestate()

setIdempotencyKey

Invocation setIdempotencyKey(@Nullable String idempotencyKey)

Idempotency key used by Restate to deduplicate the invocation.

getIdempotencyKey

@Nullable String getIdempotencyKey()

setServiceName

Invocation setServiceName(@Nullable String serviceName)

Description copied from interface: InvocationMetadata

Target service name.

Specified by:

setServiceName in interface InvocationMetadata

setHandlerName

Invocation setHandlerName(@Nullable String handlerName)

Description copied from interface: InvocationMetadata

Target handler name.

Specified by:

setHandlerName in interface InvocationMetadata

setKey

Invocation setKey(@Nullable String key)

Description copied from interface: InvocationMetadata

Target key (required when the target is a Virtual Object or Workflow).

Specified by:

setKey in interface InvocationMetadata

setScope

Invocation setScope(@Nullable String scope)

Description copied from interface: InvocationMetadata

Scope.

Specified by:

setScope in interface InvocationMetadata

setLimitKey

Invocation setLimitKey(@Nullable String limitKey)

Description copied from interface: InvocationMetadata

Rate/concurrency limit key.

Specified by:

setLimitKey in interface InvocationMetadata

putHeader

Invocation putHeader(String key,
 String value)

Description copied from interface: InvocationMetadata

Add or replace a single header.

Specified by:

putHeader in interface InvocationMetadata

setHeaders

Invocation setHeaders(@Nullable Map<String,String> headers)

Description copied from interface: InvocationMetadata

Replace the whole header map.

Specified by:

setHeaders in interface InvocationMetadata