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

Record Class EstimatedHeapUsage

java.lang.Object
java.lang.Record
org.elasticsearch.cluster.EstimatedHeapUsage
All Implemented Interfaces:
Writeable
public record EstimatedHeapUsage(String nodeId, long totalBytes, long estimatedUsageBytes) extends Record implements Writeable
Record representing an estimate of the heap used by allocated shards and ongoing merges on a particular node

  • Constructor Details

    • EstimatedHeapUsage

      public EstimatedHeapUsage(String nodeId, long totalBytes, long estimatedUsageBytes)
      Creates an instance of a EstimatedHeapUsage record class.
      Parameters:
      nodeId - the value for the nodeId record component
      totalBytes - the value for the totalBytes record component
      estimatedUsageBytes - the value for the estimatedUsageBytes record component

    • EstimatedHeapUsage

      public EstimatedHeapUsage(StreamInput in) throws IOException
      Throws:
      IOException

  • 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

    • estimatedFreeBytes

      public long estimatedFreeBytes()

    • estimatedFreeBytesAsPercentage

      public double estimatedFreeBytesAsPercentage()

    • estimatedUsageAsPercentage

      public double estimatedUsageAsPercentage()

    • estimatedUsageAsRatio

      public double estimatedUsageAsRatio()

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

    • nodeId

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

    • totalBytes

      public long totalBytes()
      Returns the value of the totalBytes record component.
      Returns:
      the value of the totalBytes record component

    • estimatedUsageBytes

      public long estimatedUsageBytes()
      Returns the value of the estimatedUsageBytes record component.
      Returns:
      the value of the estimatedUsageBytes record component