Package com.inductiveautomation.ignition.gateway.storeforward.pipeline

Record Class PipelineInformation

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.storeforward.pipeline.PipelineInformation
Record Components:
flavor - The persistent flavor of the pipeline.
primaryStoreInfo - Information about the primary data store used by the pipeline.
secondaryStoreInfo - Optional information about the secondary data store used by the pipeline.
dataSinkInfo - information about the data sinks used by the pipeline.
forwardMetric - The metric used to measure the forward rate of data the stores to any registered sink.
public record PipelineInformation(StorageKey storageKey, PersistentFlavor<?> flavor, DataStoreInformation primaryStoreInfo, Optional<DataStoreInformation> secondaryStoreInfo, Optional<DataSinkInformation> dataSinkInfo, com.codahale.metrics.Meter forwardMetric, boolean active) extends Record
A record that contains information about a data pipeline within a store and forward engine.

  • Constructor Details

  • Method Details

    • newBuilder

      public static PipelineInformation.Builder newBuilder()

    • toGson

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

    • toJson

      public static String toJson(PipelineInformation info)

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

    • storageKey

      public StorageKey storageKey()
      Returns the value of the storageKey record component.
      Returns:
      the value of the storageKey record component

    • flavor

      public PersistentFlavor<?> flavor()
      Returns the value of the flavor record component.
      Returns:
      the value of the flavor record component

    • primaryStoreInfo

      public DataStoreInformation primaryStoreInfo()
      Returns the value of the primaryStoreInfo record component.
      Returns:
      the value of the primaryStoreInfo record component

    • secondaryStoreInfo

      public Optional<DataStoreInformation> secondaryStoreInfo()
      Returns the value of the secondaryStoreInfo record component.
      Returns:
      the value of the secondaryStoreInfo record component

    • dataSinkInfo

      public Optional<DataSinkInformation> dataSinkInfo()
      Returns the value of the dataSinkInfo record component.
      Returns:
      the value of the dataSinkInfo 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

    • active

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