Module org.elasticsearch.server

Package org.elasticsearch.cluster.routing.allocation.allocator

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.

nodeToWeightChanges -

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<DiscoveryNode,org.elasticsearch.cluster.routing.allocation.allocator.BalancingRoundSummary.NodesWeightsChanges> nodeToWeightChanges, 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 Summary

Fields

Modifier and Type	Field	Description
static final BalancingRoundSummary.CombinedBalancingRoundSummary	EMPTY_RESULTS

Constructor Summary

Constructors

Constructor	Description
CombinedBalancingRoundSummary(int numberOfBalancingRounds, Map<DiscoveryNode,org.elasticsearch.cluster.routing.allocation.allocator.BalancingRoundSummary.NodesWeightsChanges> nodeToWeightChanges, long numberOfShardMoves)	Creates an instance of a CombinedBalancingRoundSummary record class.

Method Summary

Modifier and Type	Method	Description
static BalancingRoundSummary.CombinedBalancingRoundSummary	combine(List<BalancingRoundSummary> summaries)	Merges multiple BalancingRoundSummary summaries into a single BalancingRoundSummary.CombinedBalancingRoundSummary.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Map<DiscoveryNode,org.elasticsearch.cluster.routing.allocation.allocator.BalancingRoundSummary.NodesWeightsChanges>	nodeToWeightChanges()	Returns the value of the nodeToWeightChanges record component.
int	numberOfBalancingRounds()	Returns the value of the numberOfBalancingRounds record component.
long	numberOfShardMoves()	Returns the value of the numberOfShardMoves record component.
String	toString()	Serialize the CombinedBalancingRoundSummary to a compact log representation, where DiscoveryNode.getName() is used instead of the entire DiscoveryNode.toString() method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EMPTY_RESULTS

public static final BalancingRoundSummary.CombinedBalancingRoundSummary EMPTY_RESULTS

Constructor Details

CombinedBalancingRoundSummary

public CombinedBalancingRoundSummary(int numberOfBalancingRounds,
 Map<DiscoveryNode,org.elasticsearch.cluster.routing.allocation.allocator.BalancingRoundSummary.NodesWeightsChanges> nodeToWeightChanges,
 long numberOfShardMoves)

Creates an instance of a CombinedBalancingRoundSummary record class.

Parameters:

numberOfBalancingRounds - the value for the numberOfBalancingRounds record component

nodeToWeightChanges - the value for the nodeToWeightChanges record component

numberOfShardMoves - the value for the numberOfShardMoves record component

Method Details

toString

public String toString()

Serialize the CombinedBalancingRoundSummary to a compact log representation, where DiscoveryNode.getName() is used instead of the entire DiscoveryNode.toString() method.

Specified by:

toString in class Record

combine

public static BalancingRoundSummary.CombinedBalancingRoundSummary combine(List<BalancingRoundSummary> summaries)

Merges multiple BalancingRoundSummary summaries into a single BalancingRoundSummary.CombinedBalancingRoundSummary.

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

nodeToWeightChanges

public Map<DiscoveryNode,org.elasticsearch.cluster.routing.allocation.allocator.BalancingRoundSummary.NodesWeightsChanges> nodeToWeightChanges()

Returns the value of the nodeToWeightChanges record component.

Returns:

the value of the nodeToWeightChanges record component

numberOfShardMoves

public long numberOfShardMoves()

Returns the value of the numberOfShardMoves record component.

Returns:

the value of the numberOfShardMoves record component