Record Class AvailabilityState

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.AvailabilityState
Record Components:
state - the coarse lifecycle state
cause - empty for AvailabilityState.State.AVAILABLE, otherwise a short, log-friendly description

public record AvailabilityState(AvailabilityState.State state, String cause) extends Record
Whether a Historian, and the engines it owns, is currently usable. Storage, query and browse paths read it through the Supplier<AvailabilityState> wired into each engine.

Reading AbstractHistorian.availabilityState() is a single volatile load, so any thread may call it with no I/O, locks or blocking. Backends keep a volatile AvailabilityState field that background tasks update.

  • Field Details

    • AVAILABLE

      public static final AvailabilityState AVAILABLE
      The state of a normally running historian.
  • Constructor Details

    • AvailabilityState

      public AvailabilityState(AvailabilityState.State state, String cause)
      Creates an instance of a AvailabilityState record class.
      Parameters:
      state - the value for the state record component
      cause - the value for the cause record component
  • Method Details

    • unavailable

      public static AvailabilityState unavailable(String cause)
      Parameters:
      cause - a non-null, log-friendly description
    • degraded

      public static AvailabilityState degraded(String cause)
      Parameters:
      cause - a non-null, log-friendly description
    • 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 Objects::equals(Object,Object).
      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.
    • state

      public AvailabilityState.State state()
      Returns the value of the state record component.
      Returns:
      the value of the state record component
    • cause

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