Package energy.eddie.api.agnostic

Record Class RawDataMessage

java.lang.Object
java.lang.Record
energy.eddie.api.agnostic.RawDataMessage
Record Components:
permissionId - ID of the permission to which this record belongs to.
connectionId - ConnectionId of the permission this record belongs to.
dataNeedId - DataNeedId of the permission this record belongs to.
dataSourceInformation - Metadata about the region connector that produced this message.
timestamp - Timestamp when this message was created.
rawPayload - Raw data as received from the MDA.
All Implemented Interfaces:
MessageWithHeaders
public record RawDataMessage(String permissionId, String connectionId, String dataNeedId, DataSourceInformation dataSourceInformation, ZonedDateTime timestamp, String rawPayload) extends Record implements MessageWithHeaders
A record that holds the raw data as directly received from the MDA and some metadata information.

  • Constructor Details

    • RawDataMessage

      public RawDataMessage(PermissionRequest permissionRequest, String rawPayload)
      Utility constructor to create a RawDataMessage from a permission request and payload. Will always use the current ZonedDateTime for timestamp.
      Parameters:
      permissionRequest - used to populate all fields except timestamp and rawPayload
      rawPayload - the payload

    • RawDataMessage

      public RawDataMessage(String permissionId, String connectionId, String dataNeedId, DataSourceInformation dataSourceInformation, ZonedDateTime timestamp, String rawPayload)
      Creates an instance of a RawDataMessage record class.
      Parameters:
      permissionId - the value for the permissionId record component
      connectionId - the value for the connectionId record component
      dataNeedId - the value for the dataNeedId record component
      dataSourceInformation - the value for the dataSourceInformation record component
      timestamp - the value for the timestamp record component
      rawPayload - the value for the rawPayload 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. 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.

    • permissionId

      public String permissionId()
      Returns the value of the permissionId record component.
      Specified by:
      permissionId in interface MessageWithHeaders
      Returns:
      the value of the permissionId record component

    • connectionId

      public String connectionId()
      Returns the value of the connectionId record component.
      Specified by:
      connectionId in interface MessageWithHeaders
      Returns:
      the value of the connectionId record component

    • dataNeedId

      public String dataNeedId()
      Returns the value of the dataNeedId record component.
      Specified by:
      dataNeedId in interface MessageWithHeaders
      Returns:
      the value of the dataNeedId record component

    • dataSourceInformation

      public DataSourceInformation dataSourceInformation()
      Returns the value of the dataSourceInformation record component.
      Returns:
      the value of the dataSourceInformation record component

    • timestamp

      public ZonedDateTime timestamp()
      Returns the value of the timestamp record component.
      Returns:
      the value of the timestamp record component

    • rawPayload

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