Package com.inductiveautomation.ignition.gateway.storeforward.engine

Record Class EngineInformation

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.storeforward.engine.EngineInformation
Record Components:
engineId - the id for the store and forward engine
engineStatus - the status of the store and forward engine
storeMetric - the storage metric relating to data stored to the engine
forwardMetric - the forward metric relating to data forwarded to the data sinks
totalPending - the total number of pending data points within the engine
totalQuarantined - the total number of quarantined data points within the engine
totalDropped - the total number of dropped data within the engine
pipelineInformation - if the engine contains inner data pipelines, then represents the pipeline statistics
quarantinedDataInfo - List of information about the data that is quarantined in the engine.
public record EngineInformation(String engineId, EngineStatus engineStatus, com.codahale.metrics.Meter storeMetric, com.codahale.metrics.Meter forwardMetric, int totalPending, int totalQuarantined, int totalDropped, List<PipelineInformation> pipelineInformation, List<QuarantinedDataInfo> quarantinedDataInfo) extends Record
Snapshot of store and forward engine information specific for data pipelines.

  • Constructor Details

    • EngineInformation

      public EngineInformation(String engineId, EngineStatus engineStatus, com.codahale.metrics.Meter storeMetric, com.codahale.metrics.Meter forwardMetric, int totalPending, int totalQuarantined, int totalDropped, List<PipelineInformation> pipelineInformation, List<QuarantinedDataInfo> quarantinedDataInfo)
      Creates an instance of a EngineInformation record class.
      Parameters:
      engineId - the value for the engineId record component
      engineStatus - the value for the engineStatus record component
      storeMetric - the value for the storeMetric record component
      forwardMetric - the value for the forwardMetric record component
      totalPending - the value for the totalPending record component
      totalQuarantined - the value for the totalQuarantined record component
      totalDropped - the value for the totalDropped record component
      pipelineInformation - the value for the pipelineInformation record component
      quarantinedDataInfo - the value for the quarantinedDataInfo record component

  • Method Details

    • toGson

      public static com.inductiveautomation.ignition.common.gson.JsonObject toGson(EngineInformation info)

    • toJson

      public static String toJson(EngineInformation info)

    • newBuilder

      public static EngineInformation.Builder newBuilder()

    • newBuilder

      public static EngineInformation.Builder newBuilder(EngineInformation engineInformation)

    • 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 '=='.
      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.

    • engineId

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

    • engineStatus

      public EngineStatus engineStatus()
      Returns the value of the engineStatus record component.
      Returns:
      the value of the engineStatus record component

    • storeMetric

      public com.codahale.metrics.Meter storeMetric()
      Returns the value of the storeMetric record component.
      Returns:
      the value of the storeMetric record component

    • forwardMetric

      public com.codahale.metrics.Meter forwardMetric()
      Returns the value of the forwardMetric record component.
      Returns:
      the value of the forwardMetric record component

    • totalPending

      public int totalPending()
      Returns the value of the totalPending record component.
      Returns:
      the value of the totalPending record component

    • totalQuarantined

      public int totalQuarantined()
      Returns the value of the totalQuarantined record component.
      Returns:
      the value of the totalQuarantined record component

    • totalDropped

      public int totalDropped()
      Returns the value of the totalDropped record component.
      Returns:
      the value of the totalDropped record component

    • pipelineInformation

      public List<PipelineInformation> pipelineInformation()
      Returns the value of the pipelineInformation record component.
      Returns:
      the value of the pipelineInformation record component

    • quarantinedDataInfo

      public List<QuarantinedDataInfo> quarantinedDataInfo()
      Returns the value of the quarantinedDataInfo record component.
      Returns:
      the value of the quarantinedDataInfo record component