Package com.inductiveautomation.historian.gateway.api.storage.realtime

Record Class CollectorId

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.storage.realtime.CollectorId
public record CollectorId(String id, CollectionMode mode) extends Record
Represents a unique identifier for a data collector. Combines a string identifier and collection mode.

  • Constructor Details

    • CollectorId

      public CollectorId(String id, CollectionMode mode)
      Creates an instance of a CollectorId record class.
      Parameters:
      id - the value for the id record component
      mode - the value for the mode record component

  • Method Details

    • random

      public static CollectorId random(CollectionMode mode)
      Creates a collector ID with a random UUID and specified mode.
      Parameters:
      mode - The collection mode
      Returns:
      A new collector ID with a random UUID

    • fromUuid

      public static CollectorId fromUuid(UUID uuid, CollectionMode mode)
      Creates a collector ID with the specified UUID and mode.
      Parameters:
      uuid - The UUID to use as identifier
      mode - The collection mode
      Returns:
      A new collector ID

    • fromString

      public static CollectorId fromString(String id, CollectionMode mode)
      Creates a collector ID with the specified string identifier and mode.
      Parameters:
      id - The string identifier
      mode - The collection mode
      Returns:
      A new collector ID

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

    • id

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

    • mode

      public CollectionMode mode()
      Returns the value of the mode record component.
      Returns:
      the value of the mode record component