Package com.inductiveautomation.ignition.gateway.storeforward

Record Class StorageId

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.storeforward.StorageId
Record Components:
engineId - identifies the target engine
sinkId - optional identifier for a specific sink within the engine
public record StorageId(String engineId, Optional<String> sinkId) extends Record
Identifies a specific storage destination within an engine.

  • Constructor Details

  • Method Details

    • forEngine

      public static StorageId forEngine(String engineId)
      Creates a StorageId for an engine without specifying a sink.
      Parameters:
      engineId - the engine identifier
      Returns:
      new StorageId instance

    • forSink

      public static StorageId forSink(String engineId, String sinkId)
      Creates a StorageId for a specific sink within an engine.
      Parameters:
      engineId - the engine identifier
      sinkId - the sink identifier
      Returns:
      new StorageId instance

    • toString

      @NotNull public @NotNull 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. All components in this record class are compared with Objects::equals(Object,Object).
      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

    • sinkId

      public Optional<String> sinkId()
      Returns the value of the sinkId record component.
      Returns:
      the value of the sinkId record component