JavaScript is disabled on your browser.
Enclosing class:
Engine
public static record Engine.RefreshResult (boolean refreshed, long primaryTerm, long generation)
extends Record
Captures the result of a refresh operation on the index shard.
refreshed
is true if a refresh happened. If refreshed, generation
contains the generation of the index commit that the reader has opened upon refresh.
Constructor Summary
Constructors
RefreshResult (boolean refreshed,
long primaryTerm,
long generation)
Creates an instance of a RefreshResult
record class.
Method Summary
All Methods Instance Methods Concrete Methods
final boolean
Indicates whether some other object is "equal to" this one.
long
Returns the value of the generation
record component.
final int
Returns a hash code value for this object.
long
Returns the value of the primaryTerm
record component.
boolean
Returns the value of the refreshed
record component.
Returns a string representation of this record class.
Field Details
UNKNOWN_GENERATION
public static final long UNKNOWN_GENERATION
See Also:
Constructor Details
RefreshResult
public RefreshResult (boolean refreshed)
RefreshResult
public RefreshResult (boolean refreshed,
long primaryTerm,
long generation)
Creates an instance of a RefreshResult
record class.
Parameters:
refreshed
- the value for the refreshed
record component
primaryTerm
- the value for the primaryTerm
record component
generation
- the value for the generation
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.
refreshed
public boolean refreshed ()
Returns the value of the refreshed
record component.
Returns:
the value of the refreshed
record component
primaryTerm
public long primaryTerm ()
Returns the value of the primaryTerm
record component.
Returns:
the value of the primaryTerm
record component
generation
public long generation ()
Returns the value of the generation
record component.
Returns:
the value of the generation
record component