Package com.tnsai.agents.interrupt

Record Class InterruptEvent.BudgetInterrupt

java.lang.Object
java.lang.Record
com.tnsai.agents.interrupt.InterruptEvent.BudgetInterrupt
All Implemented Interfaces:
InterruptEvent
Enclosing interface:
InterruptEvent
public static record InterruptEvent.BudgetInterrupt(String reason, Instant timestamp, String budgetType, double currentUsage, double limit) extends Record implements InterruptEvent
Budget interrupt when token/cost limits are hit.

  • Constructor Details

    • BudgetInterrupt

      public BudgetInterrupt(String budgetType, double currentUsage, double limit)

    • BudgetInterrupt

      public BudgetInterrupt(String reason, Instant timestamp, String budgetType, double currentUsage, double limit)
      Creates an instance of a BudgetInterrupt record class.
      Parameters:
      reason - the value for the reason record component
      timestamp - the value for the timestamp record component
      budgetType - the value for the budgetType record component
      currentUsage - the value for the currentUsage record component
      limit - the value for the limit record component

  • Method Details

    • shouldCheckpoint

      public boolean shouldCheckpoint()
      Description copied from interface: InterruptEvent
      Returns true if the agent should checkpoint its state.
      Specified by:
      shouldCheckpoint in interface InterruptEvent

    • isResumable

      public boolean isResumable()
      Description copied from interface: InterruptEvent
      Returns true if the agent can be resumed after this interrupt.
      Specified by:
      isResumable in interface InterruptEvent

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

    • reason

      public String reason()
      Returns the value of the reason record component.
      Specified by:
      reason in interface InterruptEvent
      Returns:
      the value of the reason record component

    • timestamp

      public Instant timestamp()
      Returns the value of the timestamp record component.
      Specified by:
      timestamp in interface InterruptEvent
      Returns:
      the value of the timestamp record component

    • budgetType

      public String budgetType()
      Returns the value of the budgetType record component.
      Returns:
      the value of the budgetType record component

    • currentUsage

      public double currentUsage()
      Returns the value of the currentUsage record component.
      Returns:
      the value of the currentUsage record component

    • limit

      public double limit()
      Returns the value of the limit record component.
      Returns:
      the value of the limit record component