Record Class SagaOptions

java.lang.Object

java.lang.Record

org.j7m.middleware.api.saga.SagaOptions

Record Components:

idempotencyKey - optional key used to detect duplicate saga starts

retryPolicy - default retry policy for steps without an override

timeoutPolicy - default timeout policy for the saga execution

cancellationPolicy - cancellation behavior for this execution

All Implemented Interfaces:

Serializable

public record SagaOptions(IdempotencyKey idempotencyKey, SagaRetryPolicy retryPolicy, SagaTimeoutPolicy timeoutPolicy, SagaCancellationPolicy cancellationPolicy)
extends Record
implements Serializable

Options used when starting a saga.

Options are persisted with the execution and recovered with the original policy values. They are immutable and safe for durable event encoding.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SagaOptions(IdempotencyKey idempotencyKey, SagaRetryPolicy retryPolicy, SagaTimeoutPolicy timeoutPolicy, SagaCancellationPolicy cancellationPolicy)	Creates validated options.

Method Summary

Modifier and Type	Method	Description
SagaCancellationPolicy	cancellationPolicy()	Returns the value of the cancellationPolicy record component.
static SagaOptions	defaults()	Returns default saga start options.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
IdempotencyKey	idempotencyKey()	Returns the value of the idempotencyKey record component.
SagaRetryPolicy	retryPolicy()	Returns the value of the retryPolicy record component.
SagaTimeoutPolicy	timeoutPolicy()	Returns the value of the timeoutPolicy record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

SagaOptions

public SagaOptions(IdempotencyKey idempotencyKey,
 SagaRetryPolicy retryPolicy,
 SagaTimeoutPolicy timeoutPolicy,
 SagaCancellationPolicy cancellationPolicy)

Creates validated options.

Method Details

defaults

public static SagaOptions defaults()

Returns default saga start options.

Returns:

immutable default options with no idempotency key, no retry, no timeout, and compensation on cancel

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

idempotencyKey

public IdempotencyKey idempotencyKey()

Returns the value of the idempotencyKey record component.

Returns:

the value of the idempotencyKey record component

retryPolicy

public SagaRetryPolicy retryPolicy()

Returns the value of the retryPolicy record component.

Returns:

the value of the retryPolicy record component

timeoutPolicy

public SagaTimeoutPolicy timeoutPolicy()

Returns the value of the timeoutPolicy record component.

Returns:

the value of the timeoutPolicy record component

cancellationPolicy

public SagaCancellationPolicy cancellationPolicy()

Returns the value of the cancellationPolicy record component.

Returns:

the value of the cancellationPolicy record component