Module org.elasticsearch.server
Package org.elasticsearch.cluster.coordination

Record Class ElectionStrategy.NodeEligibility

java.lang.Object
java.lang.Record
org.elasticsearch.cluster.coordination.ElectionStrategy.NodeEligibility
Enclosing class:
ElectionStrategy
public static record ElectionStrategy.NodeEligibility(boolean mayWin, String reason) extends Record
Contains a result for whether a node may win an election and the reason if not.

  • Constructor Summary

    Constructors
    Constructor
    Description
    NodeEligibility(boolean mayWin, String reason)
    Creates an instance of a NodeEligibility 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.
    boolean
    mayWin()
    Returns the value of the mayWin record component.
    String
    reason()
    Returns the value of the reason 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

  • Constructor Details

    • NodeEligibility

      public NodeEligibility(boolean mayWin, String reason)
      Creates an instance of a NodeEligibility record class.
      Parameters:
      mayWin - the value for the mayWin record component
      reason - the value for the reason 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • mayWin

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

    • reason

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