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;nulldisables polling, so the binding fires on demand only. AlwaysnullwhenuserRefreshOnlyistrue; 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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final BindingPollingConfigNo polling configured; refresh on demand only. -
Constructor Summary
ConstructorsConstructorDescriptionBindingPollingConfig(@Nullable String pollingRateExpression, boolean userRefreshOnly) Creates an instance of aBindingPollingConfigrecord class. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.@Nullable StringReturns the value of thepollingRateExpressionrecord component.final StringtoString()Returns a string representation of this record class.booleanReturns the value of theuserRefreshOnlyrecord component.
-
Field Details
-
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 aBindingPollingConfigrecord class.- Parameters:
pollingRateExpression- the value for thepollingRateExpressionrecord componentuserRefreshOnly- the value for theuserRefreshOnlyrecord component
-
-
Method Details
-
toString
-
hashCode
-
equals
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 withObjects::equals(Object,Object); primitive components are compared with thecomparemethod from their corresponding wrapper classes. -
pollingRateExpression
Returns the value of thepollingRateExpressionrecord component.- Returns:
- the value of the
pollingRateExpressionrecord component
-
userRefreshOnly
public boolean userRefreshOnly()Returns the value of theuserRefreshOnlyrecord component.- Returns:
- the value of the
userRefreshOnlyrecord component
-