Record Class BindingPollingConfig

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.common.model.binding.BindingPollingConfig
Record Components:
pollingRateExpression - Perspective expression that evaluates to a polling rate in ms; null disables polling, so the binding fires on demand only. Always null when userRefreshOnly is true; the constructor normalizes it.
userRefreshOnly - whether to ignore the rate expression and refresh only on explicit user request, such as the Designer's refresh button or a script call.

public record BindingPollingConfig(@Nullable String pollingRateExpression, boolean userRefreshOnly) extends Record
Polling parameters of the historian.query binding, as AbstractPollingBinding accepts them.
  • Field Details

    • USER_REFRESH_ONLY

      public static final BindingPollingConfig USER_REFRESH_ONLY
      No polling configured; refresh on demand only.
  • Constructor Details

    • BindingPollingConfig

      public BindingPollingConfig(@Nullable @Nullable String pollingRateExpression, boolean userRefreshOnly)
      Creates an instance of a BindingPollingConfig record class.
      Parameters:
      pollingRateExpression - the value for the pollingRateExpression record component
      userRefreshOnly - the value for the userRefreshOnly 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.
    • pollingRateExpression

      @Nullable public @Nullable String pollingRateExpression()
      Returns the value of the pollingRateExpression record component.
      Returns:
      the value of the pollingRateExpression record component
    • userRefreshOnly

      public boolean userRefreshOnly()
      Returns the value of the userRefreshOnly record component.
      Returns:
      the value of the userRefreshOnly record component