Module org.elasticsearch.server
Package org.elasticsearch.indices

Record Class ShardLimitValidator.Result

java.lang.Object
java.lang.Record
org.elasticsearch.indices.ShardLimitValidator.Result
Enclosing class:
ShardLimitValidator
public static record ShardLimitValidator.Result(boolean canAddShards, Optional<Long> currentUsedShards, int totalShardsToAdd, int maxShardsInCluster, String group) extends Record
A Result object containing enough information to be used by external callers about the state of the cluster from the shard limits perspective.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Result(boolean canAddShards, Optional<Long> currentUsedShards, int totalShardsToAdd, int maxShardsInCluster, String group)
    Creates an instance of a Result record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canAddShards()
    Returns the value of the canAddShards record component.
    Optional<Long>
    currentUsedShards()
    Returns the value of the currentUsedShards record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    group()
    Returns the value of the group record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    maxShardsInCluster()
    Returns the value of the maxShardsInCluster record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    totalShardsToAdd()
    Returns the value of the totalShardsToAdd record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Result

      public Result(boolean canAddShards, Optional<Long> currentUsedShards, int totalShardsToAdd, int maxShardsInCluster, String group)
      Creates an instance of a Result record class.
      Parameters:
      canAddShards - the value for the canAddShards record component
      currentUsedShards - the value for the currentUsedShards record component
      totalShardsToAdd - the value for the totalShardsToAdd record component
      maxShardsInCluster - the value for the maxShardsInCluster record component
      group - the value for the group record component

  • Method Details

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

    • canAddShards

      public boolean canAddShards()
      Returns the value of the canAddShards record component.
      Returns:
      the value of the canAddShards record component

    • currentUsedShards

      public Optional<Long> currentUsedShards()
      Returns the value of the currentUsedShards record component.
      Returns:
      the value of the currentUsedShards record component

    • totalShardsToAdd

      public int totalShardsToAdd()
      Returns the value of the totalShardsToAdd record component.
      Returns:
      the value of the totalShardsToAdd record component

    • maxShardsInCluster

      public int maxShardsInCluster()
      Returns the value of the maxShardsInCluster record component.
      Returns:
      the value of the maxShardsInCluster record component

    • group

      public String group()
      Returns the value of the group record component.
      Returns:
      the value of the group record component