Module org.elasticsearch.server
Package org.elasticsearch.index.engine

Record Class SafeCommitInfo

java.lang.Object
java.lang.Record
org.elasticsearch.index.engine.SafeCommitInfo
public record SafeCommitInfo(long localCheckpoint, int docCount) extends Record
Information about the safe commit, for making decisions about recoveries.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final SafeCommitInfo
    EMPTY
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    SafeCommitInfo(long localCheckpoint, int docCount)
    Creates an instance of a SafeCommitInfo record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    docCount()
    Returns the value of the docCount record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    long
    localCheckpoint()
    Returns the value of the localCheckpoint record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • SafeCommitInfo

      public SafeCommitInfo(long localCheckpoint, int docCount)
      Creates an instance of a SafeCommitInfo record class.
      Parameters:
      localCheckpoint - the value for the localCheckpoint record component
      docCount - the value for the docCount 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 '=='.
      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.

    • localCheckpoint

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

    • docCount

      public int docCount()
      Returns the value of the docCount record component.
      Returns:
      the value of the docCount record component