Record Class ClusterBalanceStats.NodeBalanceStats

java.lang.Object
java.lang.Record
org.elasticsearch.cluster.routing.allocation.allocator.ClusterBalanceStats.NodeBalanceStats
All Implemented Interfaces:
Writeable, ToXContent, ToXContentObject
Enclosing class:
ClusterBalanceStats

public static record ClusterBalanceStats.NodeBalanceStats(String nodeId, List<String> roles, int shards, int undesiredShardAllocations, double forecastWriteLoad, long forecastShardSize, long actualShardSize) extends Record implements Writeable, ToXContentObject
  • Constructor Details

    • NodeBalanceStats

      public NodeBalanceStats(String nodeId, List<String> roles, int shards, int undesiredShardAllocations, double forecastWriteLoad, long forecastShardSize, long actualShardSize)
      Creates an instance of a NodeBalanceStats record class.
      Parameters:
      nodeId - the value for the nodeId record component
      roles - the value for the roles record component
      shards - the value for the shards record component
      undesiredShardAllocations - the value for the undesiredShardAllocations record component
      forecastWriteLoad - the value for the forecastWriteLoad record component
      forecastShardSize - the value for the forecastShardSize record component
      actualShardSize - the value for the actualShardSize record component
  • Method Details

    • readFrom

      public static ClusterBalanceStats.NodeBalanceStats 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
    • toXContent

      public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface ToXContent
      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. 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
    • roles

      public List<String> roles()
      Returns the value of the roles record component.
      Returns:
      the value of the roles record component
    • shards

      public int shards()
      Returns the value of the shards record component.
      Returns:
      the value of the shards record component
    • undesiredShardAllocations

      public int undesiredShardAllocations()
      Returns the value of the undesiredShardAllocations record component.
      Returns:
      the value of the undesiredShardAllocations record component
    • forecastWriteLoad

      public double forecastWriteLoad()
      Returns the value of the forecastWriteLoad record component.
      Returns:
      the value of the forecastWriteLoad record component
    • forecastShardSize

      public long forecastShardSize()
      Returns the value of the forecastShardSize record component.
      Returns:
      the value of the forecastShardSize record component
    • actualShardSize

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