Module org.elasticsearch.server
Record Class DesiredBalanceMetrics.RoleAllocationStats
java.lang.Object
java.lang.Record
org.elasticsearch.cluster.routing.allocation.allocator.DesiredBalanceMetrics.RoleAllocationStats
- Record Components:
totalAllocations- Shards that are assigned to a node.undesiredAllocationsExcludingShuttingDownNodes- Shards that are assigned to a node but must move to alleviate a resource constraint per theAllocationDeciders. Excludes shards that must move because of a node shutting down.
- Enclosing class:
DesiredBalanceMetrics
public static record DesiredBalanceMetrics.RoleAllocationStats(long totalAllocations, long undesiredAllocationsExcludingShuttingDownNodes)
extends Record
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionRoleAllocationStats(long totalAllocations, long undesiredAllocationsExcludingShuttingDownNodes) Creates an instance of aRoleAllocationStatsrecord class. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.final StringtoString()Returns a string representation of this record class.longReturns the value of thetotalAllocationsrecord component.longReturns the value of theundesiredAllocationsExcludingShuttingDownNodesrecord component.doubleReturn the ratio of undesired allocations to the total number of allocations.
-
Field Details
-
EMPTY
-
-
Constructor Details
-
RoleAllocationStats
public RoleAllocationStats(long totalAllocations, long undesiredAllocationsExcludingShuttingDownNodes) Creates an instance of aRoleAllocationStatsrecord class.- Parameters:
totalAllocations- the value for thetotalAllocationsrecord componentundesiredAllocationsExcludingShuttingDownNodes- the value for theundesiredAllocationsExcludingShuttingDownNodesrecord component
-
-
Method Details
-
undesiredAllocationsRatio
public double undesiredAllocationsRatio()Return the ratio of undesired allocations to the total number of allocations.- Returns:
- a value in [0.0, 1.0]
-
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. -
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. -
equals
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 '=='. -
totalAllocations
public long totalAllocations()Returns the value of thetotalAllocationsrecord component.- Returns:
- the value of the
totalAllocationsrecord component
-
undesiredAllocationsExcludingShuttingDownNodes
public long undesiredAllocationsExcludingShuttingDownNodes()Returns the value of theundesiredAllocationsExcludingShuttingDownNodesrecord component.- Returns:
- the value of the
undesiredAllocationsExcludingShuttingDownNodesrecord component
-