Record Class IndexedObjectInformation

java.lang.Object
java.lang.Record
org.springframework.data.elasticsearch.core.IndexedObjectInformation
public record IndexedObjectInformation(@Nullable String id, @Nullable String index, @Nullable Long seqNo, @Nullable Long primaryTerm, @Nullable Long version) extends Record
Value class capturing information about a newly indexed document in Elasticsearch.
Since:
4.1
Author:
Peter-Josef Meisch, Roman Puchkovskiy

  • Constructor Summary

    Constructors
    Constructor
    Description
    IndexedObjectInformation(@Nullable String id, @Nullable String index, @Nullable Long seqNo, @Nullable Long primaryTerm, @Nullable Long version)
    Creates an instance of a IndexedObjectInformation record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    @Nullable String
    id()
    Returns the value of the id record component.
    @Nullable String
    index()
    Returns the value of the index record component.
    @Nullable Long
    primaryTerm()
    Returns the value of the primaryTerm record component.
    @Nullable Long
    seqNo()
    Returns the value of the seqNo record component.
    final String
    toString()
    Returns a string representation of this record class.
    @Nullable Long
    version()
    Returns the value of the version record component.

    Methods inherited from class Object

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

  • Constructor Details

    • IndexedObjectInformation

      public IndexedObjectInformation(@Nullable String id, @Nullable String index, @Nullable Long seqNo, @Nullable Long primaryTerm, @Nullable Long version)
      Creates an instance of a IndexedObjectInformation record class.
      Parameters:
      id - the value for the id record component
      index - the value for the index record component
      seqNo - the value for the seqNo record component
      primaryTerm - the value for the primaryTerm record component
      version - the value for the version 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.

    • id

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

    • index

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

    • seqNo

      public @Nullable Long seqNo()
      Returns the value of the seqNo record component.
      Returns:
      the value of the seqNo record component

    • primaryTerm

      public @Nullable Long primaryTerm()
      Returns the value of the primaryTerm record component.
      Returns:
      the value of the primaryTerm record component

    • version

      public @Nullable Long version()
      Returns the value of the version record component.
      Returns:
      the value of the version record component