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 the AllocationDeciders. 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 Details

  • Constructor Details

    • RoleAllocationStats

      public RoleAllocationStats(long totalAllocations, long undesiredAllocationsExcludingShuttingDownNodes)
      Creates an instance of a RoleAllocationStats record class.
      Parameters:
      totalAllocations - the value for the totalAllocations record component
      undesiredAllocationsExcludingShuttingDownNodes - the value for the undesiredAllocationsExcludingShuttingDownNodes record 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

      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. All components in this record class 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.
    • totalAllocations

      public long totalAllocations()
      Returns the value of the totalAllocations record component.
      Returns:
      the value of the totalAllocations record component
    • undesiredAllocationsExcludingShuttingDownNodes

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