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

Record Class JoinReason

java.lang.Object
java.lang.Record
org.elasticsearch.cluster.coordination.JoinReason
Record Components:
message - Message describing the reason for the node joining
guidanceDocs - An optional link to troubleshooting guidance docs
public record JoinReason(String message, ReferenceDocs guidanceDocs) extends Record

  • Constructor Details

    • JoinReason

      public JoinReason(String message, @Nullable ReferenceDocs guidanceDocs)
      Creates an instance of a JoinReason record class.
      Parameters:
      message - the value for the message record component
      guidanceDocs - the value for the guidanceDocs 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.

    • message

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

    • guidanceDocs

      @Nullable public ReferenceDocs guidanceDocs()
      Returns the value of the guidanceDocs record component.
      Returns:
      the value of the guidanceDocs record component