public abstract class AggregationBuilder extends java.lang.Object implements NamedWriteable, ToXContentFragment, BaseAggregationBuilder
Aggregator
of a specific type.Modifier and Type | Class and Description |
---|---|
static class |
AggregationBuilder.CommonFields
Common xcontent fields shared among aggregator builders
|
Writeable.Reader<V>, Writeable.Writer<V>
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Modifier and Type | Field and Description |
---|---|
protected AggregatorFactories.Builder |
factoriesBuilder |
protected java.lang.String |
name |
EMPTY_PARAMS
Modifier | Constructor and Description |
---|---|
protected |
AggregationBuilder(java.lang.String name)
Constructs a new aggregation builder.
|
Modifier and Type | Method and Description |
---|---|
protected abstract AggregatorFactory<?> |
build(SearchContext context,
AggregatorFactory<?> parent)
Internal: build an
AggregatorFactory based on the configuration of this builder. |
protected AggregationBuilder |
doRewrite(QueryRewriteContext queryShardContext)
Rewrites this aggregation builder into its primitive form.
|
abstract java.util.Map<java.lang.String,java.lang.Object> |
getMetaData()
Return any associated metadata with this
AggregationBuilder . |
java.lang.String |
getName()
Return this aggregation's name.
|
java.util.List<PipelineAggregationBuilder> |
getPipelineAggregations()
Return the configured set of pipeline aggregations
|
java.util.List<AggregationBuilder> |
getSubAggregations()
Return the configured set of subaggregations
|
AggregationBuilder |
rewrite(QueryRewriteContext context) |
abstract AggregationBuilder |
setMetaData(java.util.Map<java.lang.String,java.lang.Object> metaData)
Associate metadata with this
AggregationBuilder . |
abstract AggregationBuilder |
subAggregation(AggregationBuilder aggregation)
Add a sub aggregation to this builder.
|
abstract AggregationBuilder |
subAggregation(PipelineAggregationBuilder aggregation)
Add a sub aggregation to this builder.
|
abstract AggregationBuilder |
subAggregations(AggregatorFactories.Builder subFactories)
Internal: Registers sub-factories with this factory.
|
java.lang.String |
toString() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getWriteableName
isFragment
toXContent
getType
protected final java.lang.String name
protected AggregatorFactories.Builder factoriesBuilder
protected AggregationBuilder(java.lang.String name)
name
- The aggregation namepublic java.lang.String getName()
protected abstract AggregatorFactory<?> build(SearchContext context, AggregatorFactory<?> parent) throws java.io.IOException
AggregatorFactory
based on the configuration of this builder.java.io.IOException
public abstract AggregationBuilder setMetaData(java.util.Map<java.lang.String,java.lang.Object> metaData)
AggregationBuilder
.setMetaData
in interface BaseAggregationBuilder
public abstract java.util.Map<java.lang.String,java.lang.Object> getMetaData()
AggregationBuilder
.public abstract AggregationBuilder subAggregation(AggregationBuilder aggregation)
public abstract AggregationBuilder subAggregation(PipelineAggregationBuilder aggregation)
public java.util.List<AggregationBuilder> getSubAggregations()
public java.util.List<PipelineAggregationBuilder> getPipelineAggregations()
public abstract AggregationBuilder subAggregations(AggregatorFactories.Builder subFactories)
AggregatorFactories.parseAggregators(XContentParser)
.subAggregations
in interface BaseAggregationBuilder
subFactories
- The sub-factoriespublic final AggregationBuilder rewrite(QueryRewriteContext context) throws java.io.IOException
java.io.IOException
protected AggregationBuilder doRewrite(QueryRewriteContext queryShardContext) throws java.io.IOException
java.io.IOException
public java.lang.String toString()
toString
in class java.lang.Object