Record Class IngestTelemetry.Rate

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.storage.IngestTelemetry.Rate
Enclosing class:
IngestTelemetry

public static record IngestTelemetry.Rate(double oneMinute, double fiveMinute, double fifteenMinute) extends Record
A metered rate over the 1, 5 and 15 minute exponentially weighted windows.
Since:
2027.02
  • Constructor Summary

    Constructors
    Constructor
    Description
    Rate(double oneMinute, double fiveMinute, double fifteenMinute)
    Creates an instance of a Rate record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    double
    Returns the value of the fifteenMinute record component.
    double
    Returns the value of the fiveMinute record component.
    final int
    Returns a hash code value for this object.
    double
    Returns the value of the oneMinute 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
  • Constructor Details

    • Rate

      public Rate(double oneMinute, double fiveMinute, double fifteenMinute)
      Creates an instance of a Rate record class.
      Parameters:
      oneMinute - the value for the oneMinute record component
      fiveMinute - the value for the fiveMinute record component
      fifteenMinute - the value for the fifteenMinute 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.
    • oneMinute

      public double oneMinute()
      Returns the value of the oneMinute record component.
      Returns:
      the value of the oneMinute record component
    • fiveMinute

      public double fiveMinute()
      Returns the value of the fiveMinute record component.
      Returns:
      the value of the fiveMinute record component
    • fifteenMinute

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