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

Record Class RestoreInProgress.ShardRestoreStatus

java.lang.Object
java.lang.Record
org.elasticsearch.cluster.RestoreInProgress.ShardRestoreStatus
All Implemented Interfaces:
Writeable
Enclosing class:
RestoreInProgress
public static record RestoreInProgress.ShardRestoreStatus(String nodeId, RestoreInProgress.State state, String reason) extends Record implements Writeable
Represents status of a restored shard

  • Constructor Details

    • ShardRestoreStatus

      public ShardRestoreStatus(String nodeId)
      Constructs a new shard restore status in initializing state on the given node
      Parameters:
      nodeId - node id

    • ShardRestoreStatus

      public ShardRestoreStatus(String nodeId, RestoreInProgress.State state)
      Constructs a new shard restore status in with specified state on the given node
      Parameters:
      nodeId - node id
      state - restore state

    • ShardRestoreStatus

      public ShardRestoreStatus(String nodeId, RestoreInProgress.State state, String reason)
      Creates an instance of a ShardRestoreStatus record class.
      Parameters:
      nodeId - the value for the nodeId record component
      state - the value for the state record component
      reason - the value for the reason record component

  • Method Details

    • readFrom

      public static RestoreInProgress.ShardRestoreStatus readFrom(StreamInput in) throws IOException
      Throws:
      IOException

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Writes restore status to stream output
      Specified by:
      writeTo in interface Writeable
      Parameters:
      out - stream input
      Throws:
      IOException

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

    • nodeId

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

    • state

      public RestoreInProgress.State state()
      Returns the value of the state record component.
      Returns:
      the value of the state record component

    • reason

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