Package org.elasticsearch.plugins

Class SearchPlugin.PipelineAggregationSpec

java.lang.Object

org.elasticsearch.plugins.SearchPlugin.SearchExtensionSpec<PipelineAggregationBuilder,PipelineAggregator.Parser>

org.elasticsearch.plugins.SearchPlugin.PipelineAggregationSpec

Enclosing interface:

SearchPlugin

public static class SearchPlugin.PipelineAggregationSpec
extends SearchPlugin.SearchExtensionSpec<PipelineAggregationBuilder,PipelineAggregator.Parser>

Specification for a PipelineAggregator.

Constructor Summary

Constructors

Constructor	Description
PipelineAggregationSpec(java.lang.String name, Writeable.Reader<? extends PipelineAggregationBuilder> builderReader, Writeable.Reader<? extends PipelineAggregator> aggregatorReader, PipelineAggregator.Parser parser)	Specification of a PipelineAggregator.
PipelineAggregationSpec(ParseField name, Writeable.Reader<? extends PipelineAggregationBuilder> builderReader, Writeable.Reader<? extends PipelineAggregator> aggregatorReader, PipelineAggregator.Parser parser)	Specification of a PipelineAggregator.

Method Summary

Modifier and Type	Method	Description
SearchPlugin.PipelineAggregationSpec	addResultReader(java.lang.String writeableName, Writeable.Reader<? extends InternalAggregation> resultReader)	Add a reader for the shard level results of the aggregation.
SearchPlugin.PipelineAggregationSpec	addResultReader(Writeable.Reader<? extends InternalAggregation> resultReader)	Add a reader for the shard level results of the aggregation with SearchPlugin.SearchExtensionSpec.getName()'s ParseField.getPreferredName() as the NamedWriteable.getWriteableName().
Writeable.Reader<? extends PipelineAggregator>	getAggregatorReader()	The reader for the PipelineAggregator.
java.util.Map<java.lang.String,Writeable.Reader<? extends InternalAggregation>>	getResultReaders()	Get the readers that must be registered for this aggregation's results.

Methods inherited from class org.elasticsearch.plugins.SearchPlugin.SearchExtensionSpec

getName, getParser, getReader

Methods inherited from class java.lang.Object

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

Constructor Detail

PipelineAggregationSpec

public PipelineAggregationSpec(ParseField name,
                               Writeable.Reader<? extends PipelineAggregationBuilder> builderReader,
                               Writeable.Reader<? extends PipelineAggregator> aggregatorReader,
                               PipelineAggregator.Parser parser)

Specification of a PipelineAggregator.

Parameters:

name - holds the names by which this aggregation might be parsed. The ParseField.getPreferredName() is special as it is the name by under which the readers are registered. So it is the name that the PipelineAggregationBuilder and PipelineAggregator should return from NamedWriteable.getWriteableName().

builderReader - the reader registered for this aggregation's builder. Typically a reference to a constructor that takes a StreamInput

aggregatorReader - reads the PipelineAggregator from a stream

parser - reads the aggregation builder from XContent

PipelineAggregationSpec

public PipelineAggregationSpec(java.lang.String name,
                               Writeable.Reader<? extends PipelineAggregationBuilder> builderReader,
                               Writeable.Reader<? extends PipelineAggregator> aggregatorReader,
                               PipelineAggregator.Parser parser)

Specification of a PipelineAggregator.

Parameters:

name - name by which this aggregation might be parsed or deserialized. Make sure it is the name that the PipelineAggregationBuilder and PipelineAggregator should return from NamedWriteable.getWriteableName().

builderReader - the reader registered for this aggregation's builder. Typically a reference to a constructor that takes a StreamInput

aggregatorReader - reads the PipelineAggregator from a stream

parser - reads the aggregation builder from XContent

Method Detail

addResultReader

public SearchPlugin.PipelineAggregationSpec addResultReader(Writeable.Reader<? extends InternalAggregation> resultReader)

Add a reader for the shard level results of the aggregation with SearchPlugin.SearchExtensionSpec.getName()'s ParseField.getPreferredName() as the NamedWriteable.getWriteableName().

addResultReader

public SearchPlugin.PipelineAggregationSpec addResultReader(java.lang.String writeableName,
                                                            Writeable.Reader<? extends InternalAggregation> resultReader)

Add a reader for the shard level results of the aggregation.

getAggregatorReader

public Writeable.Reader<? extends PipelineAggregator> getAggregatorReader()

The reader for the PipelineAggregator.

getResultReaders

public java.util.Map<java.lang.String,Writeable.Reader<? extends InternalAggregation>> getResultReaders()

Get the readers that must be registered for this aggregation's results.