Record Class InvocationReliabilityOptions

java.lang.Object

java.lang.Record

org.j7m.middleware.api.reliability.InvocationReliabilityOptions

Record Components:

deliverySemantics - delivery semantics

idempotencyKey - optional idempotency key

dedupeKey - optional dedupe key

orderingKey - optional ordering key

durableOperationId - optional durable operation id

fencingToken - optional fencing token

monotonicEpoch - optional epoch

causalContext - optional causal context

correlationContext - optional correlation context

replayPolicy - replay policy

duplicateDetectionPolicy - duplicate detection policy

backpressurePolicy - backpressure policy

cancellationRequested - cancellation propagation flag

maxPayloadBytes - payload limit, or zero for unset

maxResultBytes - result limit, or zero for unset

retryAfter - retry-after metadata, or null

All Implemented Interfaces:

Serializable

public record InvocationReliabilityOptions(DeliverySemantics deliverySemantics, IdempotencyKey idempotencyKey, DedupeKey dedupeKey, OrderingKey orderingKey, DurableOperationId durableOperationId, FencingToken fencingToken, MonotonicEpoch monotonicEpoch, CausalContext causalContext, CorrelationContext correlationContext, ReplayPolicy replayPolicy, DuplicateDetectionPolicy duplicateDetectionPolicy, BackpressurePolicy backpressurePolicy, boolean cancellationRequested, long maxPayloadBytes, long maxResultBytes, Duration retryAfter)
extends Record
implements Serializable

Typed reliability metadata carried through invocation options.

The record is immutable, serializable, and thread-safe. It serializes to deterministic string metadata so transports remain vendor-neutral. Raw payload values are never embedded in metadata generated by this type.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX	Prefix used for transport-neutral reliability metadata keys.

Constructor Summary

Constructors

Constructor

Description

InvocationReliabilityOptions(DeliverySemantics deliverySemantics, IdempotencyKey idempotencyKey, DedupeKey dedupeKey, OrderingKey orderingKey, DurableOperationId durableOperationId, FencingToken fencingToken, MonotonicEpoch monotonicEpoch, CausalContext causalContext, CorrelationContext correlationContext, ReplayPolicy replayPolicy, DuplicateDetectionPolicy duplicateDetectionPolicy, BackpressurePolicy backpressurePolicy, boolean cancellationRequested, long maxPayloadBytes, long maxResultBytes, Duration retryAfter)

Creates validated invocation reliability options.

Method Summary

Modifier and Type	Method	Description
BackpressurePolicy	backpressurePolicy()	Returns the value of the backpressurePolicy record component.
boolean	cancellationRequested()	Returns the value of the cancellationRequested record component.
CausalContext	causalContext()	Returns the value of the causalContext record component.
CorrelationContext	correlationContext()	Returns the value of the correlationContext record component.
DedupeKey	dedupeKey()	Returns the value of the dedupeKey record component.
static InvocationReliabilityOptions	defaults()	Returns default at-most-once reliability options.
DeliverySemantics	deliverySemantics()	Returns the value of the deliverySemantics record component.
DuplicateDetectionPolicy	duplicateDetectionPolicy()	Returns the value of the duplicateDetectionPolicy record component.
DurableOperationId	durableOperationId()	Returns the value of the durableOperationId record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
FencingToken	fencingToken()	Returns the value of the fencingToken record component.
static InvocationReliabilityOptions	fromMetadata(Map<String,String> metadata)	Decodes reliability options from invocation metadata.
final int	hashCode()	Returns a hash code value for this object.
IdempotencyKey	idempotencyKey()	Returns the value of the idempotencyKey record component.
long	maxPayloadBytes()	Returns the value of the maxPayloadBytes record component.
long	maxResultBytes()	Returns the value of the maxResultBytes record component.
Map<String,String>	mergeInto(Map<String,String> metadata)	Merges these options into existing metadata.
MonotonicEpoch	monotonicEpoch()	Returns the value of the monotonicEpoch record component.
OrderingKey	orderingKey()	Returns the value of the orderingKey record component.
ReplayPolicy	replayPolicy()	Returns the value of the replayPolicy record component.
Duration	retryAfter()	Returns the value of the retryAfter record component.
Map<String,String>	toMetadata()	Encodes these options as transport-neutral metadata.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

PREFIX

public static final String PREFIX

Prefix used for transport-neutral reliability metadata keys.

See Also:

• Constant Field Values

Constructor Details

InvocationReliabilityOptions

public InvocationReliabilityOptions(DeliverySemantics deliverySemantics,
 IdempotencyKey idempotencyKey,
 DedupeKey dedupeKey,
 OrderingKey orderingKey,
 DurableOperationId durableOperationId,
 FencingToken fencingToken,
 MonotonicEpoch monotonicEpoch,
 CausalContext causalContext,
 CorrelationContext correlationContext,
 ReplayPolicy replayPolicy,
 DuplicateDetectionPolicy duplicateDetectionPolicy,
 BackpressurePolicy backpressurePolicy,
 boolean cancellationRequested,
 long maxPayloadBytes,
 long maxResultBytes,
 Duration retryAfter)

Creates validated invocation reliability options.

Method Details

defaults

public static InvocationReliabilityOptions defaults()

Returns default at-most-once reliability options.

Returns:

default options

fromMetadata

public static InvocationReliabilityOptions fromMetadata(Map<String,String> metadata)

Decodes reliability options from invocation metadata.

Parameters:

metadata - metadata map

Returns:

decoded options

toMetadata

public Map<String,String> toMetadata()

Encodes these options as transport-neutral metadata.

Returns:

metadata map

mergeInto

public Map<String,String> mergeInto(Map<String,String> metadata)

Merges these options into existing metadata.

Parameters:

metadata - existing metadata

Returns:

merged metadata

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

deliverySemantics

public DeliverySemantics deliverySemantics()

Returns the value of the deliverySemantics record component.

Returns:

the value of the deliverySemantics record component

idempotencyKey

public IdempotencyKey idempotencyKey()

Returns the value of the idempotencyKey record component.

Returns:

the value of the idempotencyKey record component

dedupeKey

public DedupeKey dedupeKey()

Returns the value of the dedupeKey record component.

Returns:

the value of the dedupeKey record component

orderingKey

public OrderingKey orderingKey()

Returns the value of the orderingKey record component.

Returns:

the value of the orderingKey record component

durableOperationId

public DurableOperationId durableOperationId()

Returns the value of the durableOperationId record component.

Returns:

the value of the durableOperationId record component

fencingToken

public FencingToken fencingToken()

Returns the value of the fencingToken record component.

Returns:

the value of the fencingToken record component

monotonicEpoch

public MonotonicEpoch monotonicEpoch()

Returns the value of the monotonicEpoch record component.

Returns:

the value of the monotonicEpoch record component

causalContext

public CausalContext causalContext()

Returns the value of the causalContext record component.

Returns:

the value of the causalContext record component

correlationContext

public CorrelationContext correlationContext()

Returns the value of the correlationContext record component.

Returns:

the value of the correlationContext record component

replayPolicy

public ReplayPolicy replayPolicy()

Returns the value of the replayPolicy record component.

Returns:

the value of the replayPolicy record component

duplicateDetectionPolicy

public DuplicateDetectionPolicy duplicateDetectionPolicy()

Returns the value of the duplicateDetectionPolicy record component.

Returns:

the value of the duplicateDetectionPolicy record component

backpressurePolicy

public BackpressurePolicy backpressurePolicy()

Returns the value of the backpressurePolicy record component.

Returns:

the value of the backpressurePolicy record component

cancellationRequested

public boolean cancellationRequested()

Returns the value of the cancellationRequested record component.

Returns:

the value of the cancellationRequested record component

maxPayloadBytes

public long maxPayloadBytes()

Returns the value of the maxPayloadBytes record component.

Returns:

the value of the maxPayloadBytes record component

maxResultBytes

public long maxResultBytes()

Returns the value of the maxResultBytes record component.

Returns:

the value of the maxResultBytes record component

retryAfter

public Duration retryAfter()

Returns the value of the retryAfter record component.

Returns:

the value of the retryAfter record component