Module org.elasticsearch.server
Package org.elasticsearch.health.node

Record Class DiskHealthInfo

java.lang.Object
java.lang.Record
org.elasticsearch.health.node.DiskHealthInfo
All Implemented Interfaces:
Writeable
public record DiskHealthInfo(HealthStatus healthStatus, DiskHealthInfo.Cause cause) extends Record implements Writeable
The health status of the disk space of this node along with the cause.

  • Constructor Details

    • DiskHealthInfo

      public DiskHealthInfo(StreamInput in) throws IOException
      Throws:
      IOException

    • DiskHealthInfo

      public DiskHealthInfo(HealthStatus healthStatus, @Nullable DiskHealthInfo.Cause cause)
      Creates an instance of a DiskHealthInfo record class.
      Parameters:
      healthStatus - the value for the healthStatus record component
      cause - the value for the cause record component

  • Method Details

    • 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

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

    • healthStatus

      public HealthStatus healthStatus()
      Returns the value of the healthStatus record component.
      Returns:
      the value of the healthStatus record component

    • cause

      @Nullable public DiskHealthInfo.Cause cause()
      Returns the value of the cause record component.
      Returns:
      the value of the cause record component