Record Class BalancingRoundSummary.CombinedBalancingRoundSummary

java.lang.Object
java.lang.Record
org.elasticsearch.cluster.routing.allocation.allocator.BalancingRoundSummary.CombinedBalancingRoundSummary
Record Components:
numberOfBalancingRounds - How many balancing round summaries are combined in this report.
nodeNameToWeightChanges -
numberOfShardMoves - The sum of shard moves for each balancing round being combined into a single summary.
Enclosing class:
BalancingRoundSummary

public static record BalancingRoundSummary.CombinedBalancingRoundSummary(int numberOfBalancingRounds, Map<String,org.elasticsearch.cluster.routing.allocation.allocator.BalancingRoundSummary.NodesWeightsChanges> nodeNameToWeightChanges, long numberOfShardMoves) extends Record
Holds combined BalancingRoundSummary results. Essentially holds a list of the balancing events and the summed up changes across all those events: what allocation work was done across some period of time. TODO: WIP ES-10341 Note that each balancing round summary is the difference between, at the time, latest desired balance and the previous desired balance. Each summary represents a step towards the next desired balance, which is based on presuming the previous desired balance is reached. So combining them is roughly the difference between the first summary's previous desired balance and the last summary's latest desired balance.
  • Field Details

  • Constructor Details

    • CombinedBalancingRoundSummary

      public CombinedBalancingRoundSummary(int numberOfBalancingRounds, Map<String,org.elasticsearch.cluster.routing.allocation.allocator.BalancingRoundSummary.NodesWeightsChanges> nodeNameToWeightChanges, long numberOfShardMoves)
      Creates an instance of a CombinedBalancingRoundSummary record class.
      Parameters:
      numberOfBalancingRounds - the value for the numberOfBalancingRounds record component
      nodeNameToWeightChanges - the value for the nodeNameToWeightChanges record component
      numberOfShardMoves - the value for the numberOfShardMoves record component
  • Method Details

    • combine

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

      public int numberOfBalancingRounds()
      Returns the value of the numberOfBalancingRounds record component.
      Returns:
      the value of the numberOfBalancingRounds record component
    • nodeNameToWeightChanges

      public Map<String,org.elasticsearch.cluster.routing.allocation.allocator.BalancingRoundSummary.NodesWeightsChanges> nodeNameToWeightChanges()
      Returns the value of the nodeNameToWeightChanges record component.
      Returns:
      the value of the nodeNameToWeightChanges record component
    • numberOfShardMoves

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