Package org.elasticsearch.plugins

Class SearchPlugin.PipelineAggregationSpec

java.lang.Object

org.elasticsearch.plugins.SearchPlugin.SearchExtensionSpec<PipelineAggregationBuilder,org.elasticsearch.xcontent.ContextParser<String,? extends PipelineAggregationBuilder>>

org.elasticsearch.plugins.SearchPlugin.PipelineAggregationSpec

Enclosing interface:

SearchPlugin

public static class SearchPlugin.PipelineAggregationSpec
extends SearchPlugin.SearchExtensionSpec<PipelineAggregationBuilder,org.elasticsearch.xcontent.ContextParser<String,? extends PipelineAggregationBuilder>>

Specification for a PipelineAggregator.

Constructor Summary

Constructors

Constructor	Description
PipelineAggregationSpec(String name, Writeable.Reader<? extends PipelineAggregationBuilder> builderReader, Writeable.Reader<? extends PipelineAggregator> aggregatorReader, PipelineAggregator.Parser parser)	Deprecated. prefer the ctor that takes a ContextParser
PipelineAggregationSpec(String name, Writeable.Reader<? extends PipelineAggregationBuilder> builderReader, Writeable.Reader<? extends PipelineAggregator> aggregatorReader, org.elasticsearch.xcontent.ContextParser<String,? extends PipelineAggregationBuilder> parser)	Deprecated. Use PipelineAggregationSpec(String, Writeable.Reader, ContextParser) for pipelines implemented after 7.8.0
PipelineAggregationSpec(String name, Writeable.Reader<? extends PipelineAggregationBuilder> builderReader, org.elasticsearch.xcontent.ContextParser<String,? extends PipelineAggregationBuilder> parser)	Specification of a PipelineAggregator.
PipelineAggregationSpec(org.elasticsearch.xcontent.ParseField name, Writeable.Reader<? extends PipelineAggregationBuilder> builderReader, Writeable.Reader<? extends PipelineAggregator> aggregatorReader, PipelineAggregator.Parser parser)	Deprecated. prefer the ctor that takes a ContextParser
PipelineAggregationSpec(org.elasticsearch.xcontent.ParseField name, Writeable.Reader<? extends PipelineAggregationBuilder> builderReader, Writeable.Reader<? extends PipelineAggregator> aggregatorReader, org.elasticsearch.xcontent.ContextParser<String,? extends PipelineAggregationBuilder> parser)	Deprecated. Use PipelineAggregationSpec(ParseField, Writeable.Reader, ContextParser) for pipelines implemented after 7.8.0
PipelineAggregationSpec(org.elasticsearch.xcontent.ParseField name, Writeable.Reader<? extends PipelineAggregationBuilder> builderReader, org.elasticsearch.xcontent.ContextParser<String,? extends PipelineAggregationBuilder> parser)	Specification of a PipelineAggregator.

Method Summary

Modifier and Type	Method	Description
SearchPlugin.PipelineAggregationSpec	addResultReader(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()	Deprecated. Pipelines implemented after 7.8.0 do not need to be sent across the wire
Map<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 Details

PipelineAggregationSpec

public PipelineAggregationSpec(org.elasticsearch.xcontent.ParseField name,
 Writeable.Reader<? extends PipelineAggregationBuilder> builderReader,
 org.elasticsearch.xcontent.ContextParser<String,? extends PipelineAggregationBuilder> 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

parser - reads the aggregation builder from XContent

PipelineAggregationSpec

public PipelineAggregationSpec(String name,
 Writeable.Reader<? extends PipelineAggregationBuilder> builderReader,
 org.elasticsearch.xcontent.ContextParser<String,? extends PipelineAggregationBuilder> 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

parser - reads the aggregation builder from XContent

PipelineAggregationSpec

@Deprecated
public PipelineAggregationSpec(org.elasticsearch.xcontent.ParseField name,
 Writeable.Reader<? extends PipelineAggregationBuilder> builderReader,
 Writeable.Reader<? extends PipelineAggregator> aggregatorReader,
 org.elasticsearch.xcontent.ContextParser<String,? extends PipelineAggregationBuilder> parser)

Deprecated.

Use PipelineAggregationSpec(ParseField, Writeable.Reader, ContextParser) for pipelines implemented after 7.8.0

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

@Deprecated
public PipelineAggregationSpec(String name,
 Writeable.Reader<? extends PipelineAggregationBuilder> builderReader,
 Writeable.Reader<? extends PipelineAggregator> aggregatorReader,
 org.elasticsearch.xcontent.ContextParser<String,? extends PipelineAggregationBuilder> parser)

Deprecated.

Use PipelineAggregationSpec(String, Writeable.Reader, ContextParser) for pipelines implemented after 7.8.0

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

PipelineAggregationSpec

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

Deprecated.

prefer the ctor that takes a ContextParser

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

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

Deprecated.

prefer the ctor that takes a ContextParser

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

Method Details

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(String writeableName,
 Writeable.Reader<? extends InternalAggregation> resultReader)

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

getAggregatorReader

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

Deprecated.

Pipelines implemented after 7.8.0 do not need to be sent across the wire

Read the aggregator from a stream.

getResultReaders

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

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