Package org.elasticsearch.search.aggregations.bucket

Class ParsedSingleBucketAggregation

org.elasticsearch.search.aggregations.ParsedAggregation
org.elasticsearch.search.aggregations.bucket.ParsedSingleBucketAggregation
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, Aggregation, SingleBucketAggregation, HasAggregations
Direct Known Subclasses:
ParsedFilter, ParsedGlobal, ParsedMissing, ParsedNested, ParsedReverseNested, ParsedSampler
public abstract class ParsedSingleBucketAggregation extends ParsedAggregation implements SingleBucketAggregation
A base class for all the single bucket aggregations.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

    Aggregation.CommonFields

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected Aggregations
    aggregations
     

    Fields inherited from class org.elasticsearch.search.aggregations.ParsedAggregation

    metadata

    Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation

    TYPED_KEYS_DELIMITER

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    ParsedSingleBucketAggregation()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.elasticsearch.common.xcontent.XContentBuilder
    doXContentBody​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    Aggregations
    getAggregations()
     
    long
    getDocCount()
     
    protected static <T extends ParsedSingleBucketAggregation>
    T
    parseXContent​(org.elasticsearch.common.xcontent.XContentParser parser, T aggregation,  name)
     
    protected void
    setDocCount​(long docCount)
     

    Methods inherited from class org.elasticsearch.search.aggregations.ParsedAggregation

    declareAggregationFields, getMetadata, getName, parseDouble, setName, toXContent

    Methods inherited from class java.lang.

    , , , , , , , , , ,

    Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

    getMetadata, getName, getType

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

    toXContent

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

    isFragment

  • Field Details

  • Constructor Details

    • ParsedSingleBucketAggregation

      public ParsedSingleBucketAggregation()

  • Method Details

    • getDocCount

      public long getDocCount()
      Specified by:
      getDocCount in interface SingleBucketAggregation
      Returns:
      The number of documents in this bucket

    • setDocCount

      protected void setDocCount​(long docCount)

    • getAggregations

      public Aggregations getAggregations()
      Specified by:
      getAggregations in interface HasAggregations
      Specified by:
      getAggregations in interface SingleBucketAggregation
      Returns:
      The sub-aggregations of this bucket

    • doXContentBody

      public org.elasticsearch.common.xcontent.XContentBuilder doXContentBody​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws
      Specified by:
      doXContentBody in class ParsedAggregation
      Throws:

    • parseXContent

      protected static <T extends ParsedSingleBucketAggregation> T parseXContent​(org.elasticsearch.common.xcontent.XContentParser parser, T aggregation,  name) throws
      Throws: