Package com.inductiveautomation.eventstream.gateway.eventbus

Record Class EventStreamEventBus.Payload

java.lang.Object
java.lang.Record
com.inductiveautomation.eventstream.gateway.eventbus.EventStreamEventBus.Payload
Record Components:
project - Name of project EventStream resource exists in
path - Path to EventStream resource
data - Object to send to EventStream. MUST be serializable, since it's possible to send through GAN
ack - True, block response until the Payload is handled by the EventStreamHandler. False, response will complete once Payload makes it to destination EventStreamSource
serverId - Name of destination gateway, null if sending locally.
Enclosing class:
EventStreamEventBus
public static record EventStreamEventBus.Payload(String project, String path, String data, boolean ack, @Nullable String serverId) extends Record

  • Constructor Details

    • Payload

      public Payload(String project, String path, String data, boolean ack, @Nullable String serverId)
      Creates an instance of a Payload record class.
      Parameters:
      project - the value for the project record component
      path - the value for the path record component
      data - the value for the data record component
      ack - the value for the ack record component
      serverId - the value for the serverId record component

  • Method Details

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

    • project

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

    • path

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

    • data

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

    • ack

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

    • serverId

      @Nullable public String serverId()
      Returns the value of the serverId record component.
      Returns:
      the value of the serverId record component