Record Class Percentiles

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.storage.strategy.Percentiles

public record Percentiles(long p50, long p95, long max) extends Record
The three points of a distribution worth showing an operator: typical, tail, and worst.
Since:
2027.02
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Percentiles
    No samples yet.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Percentiles(long p50, long p95, long max)
    Creates an instance of a Percentiles record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    long
    max()
    Returns the value of the max record component.
    of(com.codahale.metrics.Snapshot snapshot)
    Rounds a reservoir snapshot half up to p50, p95 and max.
    long
    p50()
    Returns the value of the p50 record component.
    long
    p95()
    Returns the value of the p95 record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • EMPTY

      public static final Percentiles EMPTY
      No samples yet.
  • Constructor Details

    • Percentiles

      public Percentiles(long p50, long p95, long max)
      Creates an instance of a Percentiles record class.
      Parameters:
      p50 - the value for the p50 record component
      p95 - the value for the p95 record component
      max - the value for the max record component
  • Method Details

    • of

      public static Percentiles of(com.codahale.metrics.Snapshot snapshot)
      Rounds a reservoir snapshot half up to p50, p95 and max.
      Parameters:
      snapshot - the reservoir snapshot.
      Returns:
      the three points; EMPTY when the snapshot holds no samples.
    • 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.
    • p50

      public long p50()
      Returns the value of the p50 record component.
      Returns:
      the value of the p50 record component
    • p95

      public long p95()
      Returns the value of the p95 record component.
      Returns:
      the value of the p95 record component
    • max

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