Module org.elasticsearch.server
Package org.elasticsearch.search.aggregations.bucket.terms

Record Class TermsAggregator.ConstantBucketCountThresholds

java.lang.Object
java.lang.Record
org.elasticsearch.search.aggregations.bucket.terms.TermsAggregator.ConstantBucketCountThresholds
Enclosing class:
TermsAggregator
public static record TermsAggregator.ConstantBucketCountThresholds(long minDocCount, long shardMinDocCount, int requiredSize, int shardSize) extends Record
This class provides bucket thresholds configuration, but can be used ensure default value immutability

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConstantBucketCountThresholds(long minDocCount, long shardMinDocCount, int requiredSize, int shardSize)
    Creates an instance of a ConstantBucketCountThresholds record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    long
    minDocCount()
    Returns the value of the minDocCount record component.
    int
    requiredSize()
    Returns the value of the requiredSize record component.
    long
    shardMinDocCount()
    Returns the value of the shardMinDocCount record component.
    int
    shardSize()
    Returns the value of the shardSize record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ConstantBucketCountThresholds

      public ConstantBucketCountThresholds(long minDocCount, long shardMinDocCount, int requiredSize, int shardSize)
      Creates an instance of a ConstantBucketCountThresholds record class.
      Parameters:
      minDocCount - the value for the minDocCount record component
      shardMinDocCount - the value for the shardMinDocCount record component
      requiredSize - the value for the requiredSize record component
      shardSize - the value for the shardSize 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. 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.

    • minDocCount

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

    • shardMinDocCount

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

    • requiredSize

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

    • shardSize

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