Record Class DesiredBalanceMetrics.AllocationStats

java.lang.Object
java.lang.Record
org.elasticsearch.cluster.routing.allocation.allocator.DesiredBalanceMetrics.AllocationStats
Record Components:
unassignedShards - Shards that are not assigned to any node.
allocationStatsByRole - A breakdown of the allocations stats by ShardRouting.Role
Enclosing class:
DesiredBalanceMetrics

public static record DesiredBalanceMetrics.AllocationStats(long unassignedShards, Map<ShardRouting.Role,DesiredBalanceMetrics.RoleAllocationStats> allocationStatsByRole) extends Record
  • Constructor Details

    • AllocationStats

      public AllocationStats(long unassignedShards, long totalAllocations, long undesiredAllocationsExcludingShuttingDownNodes)
    • AllocationStats

      public AllocationStats(long unassignedShards, Map<ShardRouting.Role,DesiredBalanceMetrics.RoleAllocationStats> allocationStatsByRole)
      Creates an instance of a AllocationStats record class.
      Parameters:
      unassignedShards - the value for the unassignedShards record component
      allocationStatsByRole - the value for the allocationStatsByRole record component
  • Method Details

    • totalAllocations

      public long totalAllocations()
    • undesiredAllocationsExcludingShuttingDownNodes

      public long undesiredAllocationsExcludingShuttingDownNodes()
    • 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

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

      public long unassignedShards()
      Returns the value of the unassignedShards record component.
      Returns:
      the value of the unassignedShards record component
    • allocationStatsByRole

      Returns the value of the allocationStatsByRole record component.
      Returns:
      the value of the allocationStatsByRole record component