Record Class RateLimiter.RateLimiterSnapshot

java.lang.Object
java.lang.Record
com.loomcache.server.ratelimit.RateLimiter.RateLimiterSnapshot
Enclosing class:
RateLimiter
public static record RateLimiter.RateLimiterSnapshot(double currentRate, long remainingPermits, long windowStartTime, long totalAllowed, long totalDenied, double utilizationRate) extends Record
Snapshot of rate limiter state including metrics and rates.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RateLimiterSnapshot(double currentRate, long remainingPermits, long windowStartTime, long totalAllowed, long totalDenied, double utilizationRate)
    Creates an instance of a RateLimiterSnapshot record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    currentRate()
    Returns the value of the currentRate record component.
    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.
    long
    remainingPermits()
    Returns the value of the remainingPermits record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    totalAllowed()
    Returns the value of the totalAllowed record component.
    long
    totalDenied()
    Returns the value of the totalDenied record component.
    double
    utilizationRate()
    Returns the value of the utilizationRate record component.
    long
    windowStartTime()
    Returns the value of the windowStartTime record component.

    Methods inherited from class Object

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

  • Constructor Details

    • RateLimiterSnapshot

      public RateLimiterSnapshot(double currentRate, long remainingPermits, long windowStartTime, long totalAllowed, long totalDenied, double utilizationRate)
      Creates an instance of a RateLimiterSnapshot record class.
      Parameters:
      currentRate - the value for the currentRate record component
      remainingPermits - the value for the remainingPermits record component
      windowStartTime - the value for the windowStartTime record component
      totalAllowed - the value for the totalAllowed record component
      totalDenied - the value for the totalDenied record component
      utilizationRate - the value for the utilizationRate record component

  • Method Details

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

    • currentRate

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

    • remainingPermits

      public long remainingPermits()
      Returns the value of the remainingPermits record component.
      Returns:
      the value of the remainingPermits record component

    • windowStartTime

      public long windowStartTime()
      Returns the value of the windowStartTime record component.
      Returns:
      the value of the windowStartTime record component

    • totalAllowed

      public long totalAllowed()
      Returns the value of the totalAllowed record component.
      Returns:
      the value of the totalAllowed record component

    • totalDenied

      public long totalDenied()
      Returns the value of the totalDenied record component.
      Returns:
      the value of the totalDenied record component

    • utilizationRate

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