Package org.elasticsearch.search.aggregations

Class AggregatorFactories.Builder

org.elasticsearch.search.aggregations.AggregatorFactories.Builder
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
Enclosing class:
AggregatorFactories
public static class AggregatorFactories.Builder extends implements Writeable, org.elasticsearch.common.xcontent.ToXContentObject
A mutable collection of AggregationBuilders and PipelineAggregationBuilders.

  • Constructor Details

    • Builder

      public Builder()
      Create an empty builder.

    • Builder

      public Builder​(StreamInput in) throws
      Read from a stream.
      Throws:

  • Method Details

    • writeTo

      public void writeTo​(StreamOutput out) throws
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:

    • mustVisitAllDocs

      public boolean mustVisitAllDocs()

    • addAggregator

      public AggregatorFactories.Builder addAggregator​(AggregationBuilder factory)

    • addPipelineAggregator

      public AggregatorFactories.Builder addPipelineAggregator​(PipelineAggregationBuilder pipelineAggregatorFactory)

    • validate

      public ActionRequestValidationException validate​(ActionRequestValidationException e)
      Validate the root of the aggregation tree.

    • build

      public AggregatorFactories build​(AggregationContext context, AggregatorFactory parent) throws
      Throws:

    • getAggregatorFactories

      public <AggregationBuilder> getAggregatorFactories()

    • getPipelineAggregatorFactories

      public <PipelineAggregationBuilder> getPipelineAggregatorFactories()

    • count

      public int count()

    • toXContent

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

    • bytesToPreallocate

      public long bytesToPreallocate()
      Bytes to preallocate on the "request" breaker for these aggregations. The goal is to request a few more bytes than we expect to use at first to cut down on contention on the "request" breaker when we are constructing the aggs. Underestimating what we allocate up front will fail to accomplish the goal. Overestimating will cause requests to fail for no reason.

    • toString

      public  toString()
      Overrides:
       in class 

    • hashCode

      public int hashCode()
      Overrides:
       in class 

    • equals

      public boolean equals​( obj)
      Overrides:
       in class 

    • rewrite

      public AggregatorFactories.Builder rewrite​(QueryRewriteContext context) throws
      Rewrites the underlying aggregation builders into their primitive form. If the builder did not change the identity reference must be returned otherwise the builder will be rewritten infinitely.
      Throws:

    • buildPipelineTree

      public PipelineAggregator.PipelineTree buildPipelineTree()
      Build a tree of PipelineAggregators to modify the tree of aggregation results after the final reduction.