Record Class BalancingRoundSummary

java.lang.Object
java.lang.Record
org.elasticsearch.cluster.routing.allocation.allocator.BalancingRoundSummary
Record Components:
nodeNameToWeightChanges - The shard balance weight changes for each node (by name), comparing a previous DesiredBalance shard allocation to a new DesiredBalance allocation.
numberOfShardsToMove - The number of shard moves required to move from the previous desired balance to the new one. Does not include new (index creation) or removed (index deletion) shard assignements.

public record BalancingRoundSummary(Map<String,org.elasticsearch.cluster.routing.allocation.allocator.BalancingRoundSummary.NodesWeightsChanges> nodeNameToWeightChanges, long numberOfShardsToMove) extends Record
Summarizes the impact to the cluster as a result of a rebalancing round.
  • Constructor Details

    • BalancingRoundSummary

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

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

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