Package com.inductiveautomation.eventstream.gateway.api

Record Class EventStreamContext

java.lang.Object
java.lang.Record
com.inductiveautomation.eventstream.gateway.api.EventStreamContext
Record Components:
project - Project name where the Event Stream exists.
path - Path to Event Stream resource
logger - Logger specific to location in Event Stream. Use of this logger should be preferred to creating a new logger, as it provides additional context about the Event Stream and the location the logger is being used.
public record EventStreamContext(ResourceId resourceId, String stageName, LoggerEx logger) extends Record
Context specific to an Event Stream

  • Constructor Details

    • EventStreamContext

      public EventStreamContext(ResourceId resourceId, String stageName, LoggerEx logger)
      Creates an instance of a EventStreamContext record class.
      Parameters:
      resourceId - the value for the resourceId record component
      stageName - the value for the stageName record component
      logger - the value for the logger record component

  • Method Details

    • project

      public String project()

    • path

      public String path()

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

    • resourceId

      public ResourceId resourceId()
      Returns the value of the resourceId record component.
      Returns:
      the value of the resourceId record component

    • stageName

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

    • logger

      public LoggerEx logger()
      Returns the value of the logger record component.
      Returns:
      the value of the logger record component