Package de.elo.ix.client.esearch.aggregations

Class TermsAggregationResult

java.lang.Object
de.elo.ix.client.esearch.aggregations.TermsAggregationResult
All Implemented Interfaces:
Serializable
public class TermsAggregationResult extends Object implements Serializable
The result object of a terms aggregation.
It consists mainly of buckets and within its inner aggregations results (sub-aggregations).
Since:
21.03.000.001
See Also:

  • Field Details

    • buckets

      protected List<Bucket> buckets
      The buckets (main part of a terms aggregation).

    • sumOtherDocCount

      protected long sumOtherDocCount
      Number of documents that didn’t make it into the the top size terms.
      If this is greater than 0, you can be sure that the terms agg had to throw away some buckets, either because they didn’t fit into size on the coordinating node or they didn’t fit into shard_size on the data node.

    • docCountErrorUpperBound

      protected long docCountErrorUpperBound
      If you set the show_term_doc_count_error parameter to true, the terms aggregation will include doc_count_error_upper_bound, which is an upper bound to the error on the doc_count returned by each shard. It’s the sum of the size of the largest bucket on each shard that didn’t fit into shard_size.

  • Constructor Details

    • TermsAggregationResult

      public TermsAggregationResult()

  • Method Details

    • getBuckets

      public List<Bucket> getBuckets()

    • setBuckets

      public void setBuckets(List<Bucket> buckets)

    • getSumOtherDocCount

      public long getSumOtherDocCount()

    • setSumOtherDocCount

      public void setSumOtherDocCount(long sumOtherDocCount)

    • getDocCountErrorUpperBound

      public long getDocCountErrorUpperBound()

    • setDocCountErrorUpperBound

      public void setDocCountErrorUpperBound(long docCountErrorUpperBound)

    • toString

      public String toString()
      Overrides:
      toString in class Object