Record Class SagaTimeoutPolicy

java.lang.Object
java.lang.Record
org.j7m.middleware.api.saga.SagaTimeoutPolicy
Record Components:
sagaTimeout - maximum duration for the entire saga execution
stepTimeout - maximum duration for one running step
All Implemented Interfaces:
Serializable
public record SagaTimeoutPolicy(Duration sagaTimeout, Duration stepTimeout) extends Record implements Serializable
Saga and step timeout policy.

Durations are interpreted by the saga implementation's deterministic clock. A zero duration disables the corresponding timeout.

See Also:

  • Constructor Details

    • SagaTimeoutPolicy

      public SagaTimeoutPolicy(Duration sagaTimeout, Duration stepTimeout)
      Creates a validated timeout policy.

  • Method Details

    • none

      public static SagaTimeoutPolicy none()
      Returns a policy with saga and step timeouts disabled.
      Returns:
      timeout policy with zero durations

    • 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.

    • sagaTimeout

      public Duration sagaTimeout()
      Returns the value of the sagaTimeout record component.
      Returns:
      the value of the sagaTimeout record component

    • stepTimeout

      public Duration stepTimeout()
      Returns the value of the stepTimeout record component.
      Returns:
      the value of the stepTimeout record component