Module org.elasticsearch.server
Package org.elasticsearch.cluster.routing

Record Class RelocationFailureInfo

java.lang.Object
java.lang.Record
org.elasticsearch.cluster.routing.RelocationFailureInfo
All Implemented Interfaces:
Writeable, ToXContent, ToXContentFragment
public record RelocationFailureInfo(int failedRelocations) extends Record implements ToXContentFragment, Writeable
Holds additional information as to why the shard failed to relocate.

  • Field Details

  • Constructor Details

    • RelocationFailureInfo

      public RelocationFailureInfo(int failedRelocations)
      Creates an instance of a RelocationFailureInfo record class.
      Parameters:
      failedRelocations - the value for the failedRelocations record component

  • Method Details

    • readFrom

      public static RelocationFailureInfo readFrom(StreamInput in) throws IOException
      Throws:
      IOException

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • incFailedRelocations

      public RelocationFailureInfo incFailedRelocations()

    • toXContent

      public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface ToXContent
      Throws:
      IOException

    • toString

      public 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.

    • failedRelocations

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