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

Record Class ShardAndIndexHeapUsage

java.lang.Object
java.lang.Record
org.elasticsearch.cluster.ShardAndIndexHeapUsage
All Implemented Interfaces:
Writeable
public record ShardAndIndexHeapUsage(long shardHeapUsageBytes, long indexHeapUsageBytes) extends Record implements Writeable
Tracks a shard's heap usage, as well as any index-level heap usage overhead that should be deduplicated per node.

  • Field Details

    • ZERO

      public static final ShardAndIndexHeapUsage ZERO
      Used when no collector-specific default is available.

  • Constructor Details

    • ShardAndIndexHeapUsage

      public ShardAndIndexHeapUsage(long shardHeapUsageBytes, long indexHeapUsageBytes)
      Creates an instance of a ShardAndIndexHeapUsage record class.
      Parameters:
      shardHeapUsageBytes - the value for the shardHeapUsageBytes record component
      indexHeapUsageBytes - the value for the indexHeapUsageBytes record component

    • ShardAndIndexHeapUsage

      public ShardAndIndexHeapUsage(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

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

    • shardHeapUsageBytes

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

    • indexHeapUsageBytes

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