Record Class HeartbeatRequested

java.lang.Object
java.lang.Record
ai.redouble.nucleo.events.heartbeat.HeartbeatRequested
All Implemented Interfaces:
HeartbeatEvent, JobEvent
public record HeartbeatRequested(Heartbeat heartbeat, Instant timestamp) extends Record implements HeartbeatEvent
A framework-minted heartbeat on its way to the store. Constructing one requires a Heartbeat, which application code cannot mint - the capture paths are the only sources, so this event's presence on the bus already implies captured authority.
Since:
0.1 (2026-08-29)
Author:
Andrey Santrosyan

  • Constructor Details

    • HeartbeatRequested

      public HeartbeatRequested(Heartbeat heartbeat)

    • HeartbeatRequested

      public HeartbeatRequested(Heartbeat heartbeat, Instant timestamp)
      Creates an instance of a HeartbeatRequested record class.
      Parameters:
      heartbeat - the value for the heartbeat record component
      timestamp - the value for the timestamp record component

  • Method Details

    • message

      public String message()
      Description copied from interface: JobEvent
      Gets the message associated with this event. May provide additional context about the state change or event.
      Specified by:
      message in interface JobEvent
      Returns:
      the event message, may be null

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

    • heartbeat

      public Heartbeat heartbeat()
      Returns the value of the heartbeat record component.
      Returns:
      the value of the heartbeat record component

    • timestamp

      public Instant timestamp()
      Returns the value of the timestamp record component.
      Specified by:
      timestamp in interface JobEvent
      Returns:
      the value of the timestamp record component