Record Class PerClientRateLimiter.AggregateStats

java.lang.Object
java.lang.Record
com.loomcache.server.ratelimit.PerClientRateLimiter.AggregateStats
Enclosing class:
PerClientRateLimiter
public static record PerClientRateLimiter.AggregateStats(long totalClientsTracked, long totalAllowedAcrossAllClients, long totalDeniedAcrossAllClients, double overallDenyRate, long timestamp) extends Record
Aggregate statistics across all clients.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AggregateStats(long totalClientsTracked, long totalAllowedAcrossAllClients, long totalDeniedAcrossAllClients, double overallDenyRate, long timestamp)
    Creates an instance of a AggregateStats record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    double
    overallDenyRate()
    Returns the value of the overallDenyRate record component.
    long
    timestamp()
    Returns the value of the timestamp record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    totalAllowedAcrossAllClients()
    Returns the value of the totalAllowedAcrossAllClients record component.
    long
    totalClientsTracked()
    Returns the value of the totalClientsTracked record component.
    long
    totalDeniedAcrossAllClients()
    Returns the value of the totalDeniedAcrossAllClients record component.

    Methods inherited from class Object

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

  • Constructor Details

    • AggregateStats

      public AggregateStats(long totalClientsTracked, long totalAllowedAcrossAllClients, long totalDeniedAcrossAllClients, double overallDenyRate, long timestamp)
      Creates an instance of a AggregateStats record class.
      Parameters:
      totalClientsTracked - the value for the totalClientsTracked record component
      totalAllowedAcrossAllClients - the value for the totalAllowedAcrossAllClients record component
      totalDeniedAcrossAllClients - the value for the totalDeniedAcrossAllClients record component
      overallDenyRate - the value for the overallDenyRate record component
      timestamp - the value for the timestamp 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.

    • totalClientsTracked

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

    • totalAllowedAcrossAllClients

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

    • totalDeniedAcrossAllClients

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

    • overallDenyRate

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

    • timestamp

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