AggregatorFactories (server 7.6.2 API)

java.lang.Object

org.elasticsearch.search.aggregations.AggregatorFactories

public class AggregatorFactories
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class AggregatorFactories.Builder
Field Summary

Fields

Modifier and Type Field Description

static AggregatorFactories EMPTY

static java.util.regex.Pattern VALID_AGG_NAME

Method Summary

Modifier and Type	Method	Description
`static AggregatorFactories.Builder`	`builder()`
`int`	`countAggregators()`
`int`	`countPipelineAggregators()`
`java.util.List<PipelineAggregator>`	`createPipelineAggregators()`
`Aggregator[]`	`createSubAggregators(SearchContext searchContext, Aggregator parent)`	Create all aggregators so that they can be consumed with multiple buckets.
`Aggregator[]`	`createTopLevelAggregators(SearchContext searchContext)`
`static AggregatorFactories.Builder`	`parseAggregators(XContentParser parser)`	Parses the aggregation request recursively generating aggregator factories in turn.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- VALID_AGG_NAME
  
  public static final java.util.regex.Pattern VALID_AGG_NAME
- EMPTY
  
  public static final AggregatorFactories EMPTY
Method Details
- parseAggregators
  
  public static AggregatorFactories.Builder parseAggregators(XContentParser parser) throws java.io.IOException
  
  Parses the aggregation request recursively generating aggregator factories in turn.
  
  Throws:
  
  java.io.IOException
- builder
  
  public static AggregatorFactories.Builder builder()
- createPipelineAggregators
  
  public java.util.List<PipelineAggregator> createPipelineAggregators()
- createSubAggregators
  
  public Aggregator[] createSubAggregators(SearchContext searchContext, Aggregator parent) throws java.io.IOException
  
  Create all aggregators so that they can be consumed with multiple buckets.
  
  Throws:
  
  java.io.IOException
- createTopLevelAggregators
  
  public Aggregator[] createTopLevelAggregators(SearchContext searchContext) throws java.io.IOException
  
  Throws:
  
  java.io.IOException
- countAggregators
  
  public int countAggregators()
  
  Returns:
  
  the number of sub-aggregator factories not including pipeline aggregator factories
- countPipelineAggregators
  
  public int countPipelineAggregators()
  
  Returns:
  
  the number of pipeline aggregator factories