Record Class EngineStatus
java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.storeforward.engine.EngineStatus
- Record Components:
mode- the mode (state) that the engine is currently runningreasoning- any additional messages that pertain to why the modeaccepting- if the engine is currently accepting data
public record EngineStatus(EngineStatus.EngineMode mode, Optional<LocalizedString> reasoning, boolean accepting)
extends Record
The store and forward engine status.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumThe modes an engine can report. -
Constructor Summary
ConstructorsConstructorDescriptionEngineStatus(EngineStatus.EngineMode mode, Optional<LocalizedString> reasoning, boolean accepting) Creates an instance of aEngineStatusrecord class. -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns the value of theacceptingrecord component.final booleanIndicates whether some other object is "equal to" this one.static EngineStatuserroredStatus(@Nullable LocalizedString reasoning) static EngineStatusfinal inthashCode()Returns a hash code value for this object.mode()Returns the value of themoderecord component.Returns the value of thereasoningrecord component.static EngineStatusstorageOnlyStatus(@Nullable LocalizedString reasoning) final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
EngineStatus
public EngineStatus(EngineStatus.EngineMode mode, Optional<LocalizedString> reasoning, boolean accepting) Creates an instance of aEngineStatusrecord class.
-
-
Method Details
-
fullyOperationStatus
-
storageOnlyStatus
-
erroredStatus
-
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. -
mode
-
reasoning
-
accepting
-