public abstract class PipelineAggregationBuilder extends ToXContentToBytes implements NamedWriteable, BaseAggregationBuilder
PipelineAggregator
of a
specific type.Writeable.Reader<V>, Writeable.Writer<V>
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Modifier and Type | Field and Description |
---|---|
protected java.lang.String[] |
bucketsPaths |
protected java.lang.String |
name |
EMPTY_PARAMS
Modifier | Constructor and Description |
---|---|
protected |
PipelineAggregationBuilder(java.lang.String name,
java.lang.String[] bucketsPaths)
Constructs a new pipeline aggregator factory.
|
Modifier and Type | Method and Description |
---|---|
protected abstract PipelineAggregator |
create()
Creates the pipeline aggregator
|
java.lang.String[] |
getBucketsPaths()
Return the consumed buckets paths.
|
java.lang.String |
getName()
Return this aggregation's name.
|
abstract PipelineAggregationBuilder |
setMetaData(java.util.Map<java.lang.String,java.lang.Object> metaData)
Associate metadata with this
PipelineAggregationBuilder . |
PipelineAggregationBuilder |
subAggregations(AggregatorFactories.Builder subFactories)
Set the sub aggregations if this aggregation supports sub aggregations.
|
protected abstract void |
validate(AggregatorFactory<?> parent,
AggregatorFactory<?>[] factories,
java.util.List<PipelineAggregationBuilder> pipelineAggregatorFactories)
Internal: Validates the state of this factory (makes sure the factory is properly
configured)
|
buildAsBytes, buildAsBytes, toString, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getWriteableName
getType
isFragment, toXContent
protected final java.lang.String name
protected final java.lang.String[] bucketsPaths
protected PipelineAggregationBuilder(java.lang.String name, java.lang.String[] bucketsPaths)
name
- The aggregation namepublic java.lang.String getName()
public final java.lang.String[] getBucketsPaths()
protected abstract void validate(AggregatorFactory<?> parent, AggregatorFactory<?>[] factories, java.util.List<PipelineAggregationBuilder> pipelineAggregatorFactories)
protected abstract PipelineAggregator create() throws java.io.IOException
java.io.IOException
public abstract PipelineAggregationBuilder setMetaData(java.util.Map<java.lang.String,java.lang.Object> metaData)
PipelineAggregationBuilder
.setMetaData
in interface BaseAggregationBuilder
public PipelineAggregationBuilder subAggregations(AggregatorFactories.Builder subFactories)
BaseAggregationBuilder
this
for chaining.subAggregations
in interface BaseAggregationBuilder