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

Record Class DesiredBalance

java.lang.Object
java.lang.Record
org.elasticsearch.cluster.routing.allocation.allocator.DesiredBalance
Record Components:
assignments - a set of the (persistent) node IDs to which each ShardId should be allocated
public record DesiredBalance(long lastConvergedIndex, Map<ShardId,ShardAssignment> assignments) extends Record
The desired balance of the cluster, indicating which nodes should hold a copy of each shard.

  • Field Details

  • Constructor Details

    • DesiredBalance

      public DesiredBalance(long lastConvergedIndex, Map<ShardId,ShardAssignment> assignments)
      Creates an instance of a DesiredBalance record class.
      Parameters:
      lastConvergedIndex - the value for the lastConvergedIndex record component
      assignments - the value for the assignments record component

  • Method Details

    • getAssignment

      public ShardAssignment getAssignment(ShardId shardId)

    • hasChanges

      public static boolean hasChanges(DesiredBalance a, DesiredBalance b)

    • shardMovements

      public static int shardMovements(DesiredBalance old, DesiredBalance updated)

    • humanReadableDiff

      public static String humanReadableDiff(DesiredBalance old, DesiredBalance updated)

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

    • lastConvergedIndex

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

    • assignments

      public Map<ShardId,ShardAssignment> assignments()
      Returns the value of the assignments record component.
      Returns:
      the value of the assignments record component