Record Class ConsensusLogEntryStatus

java.lang.Object
java.lang.Record
org.j7m.middleware.api.consensus.ConsensusLogEntryStatus
Record Components:
index - log index
term - entry term
commandId - safe command id
payloadBytes - payload byte count
committed - whether the entry is committed on the reporting node
applied - whether the entry has been applied on the reporting node
All Implemented Interfaces:
Serializable
public record ConsensusLogEntryStatus(LogIndex index, ConsensusTerm term, String commandId, long payloadBytes, boolean committed, boolean applied) extends Record implements Serializable
Redacted public status metadata for a consensus log entry.

This record is immutable and safe to expose through status APIs. It never contains the raw ConsensusCommand.payload() bytes. The command id is treated as caller-supplied safe metadata; sensitive data must not be embedded in command ids.

See Also:

  • Constructor Details

    • ConsensusLogEntryStatus

      public ConsensusLogEntryStatus(LogIndex index, ConsensusTerm term, String commandId, long payloadBytes, boolean committed, boolean applied)
      Creates redacted log entry status.

  • 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 the compare method from their corresponding wrapper classes.
      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.

    • index

      public LogIndex index()
      Returns the value of the index record component.
      Returns:
      the value of the index record component

    • term

      public ConsensusTerm term()
      Returns the value of the term record component.
      Returns:
      the value of the term record component

    • commandId

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

    • payloadBytes

      public long payloadBytes()
      Returns the value of the payloadBytes record component.
      Returns:
      the value of the payloadBytes record component

    • committed

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

    • applied

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