org.elasticsearch.plugins

Interface SearchPlugin

public interface SearchPlugin

Plugin for extending search time behavior.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SearchPlugin.AggregationSpec Specification for an Aggregation.
static class	SearchPlugin.FetchPhaseConstructionContext Context available during fetch phase construction.
static class	SearchPlugin.PipelineAggregationSpec Specification for a PipelineAggregator.
static class	SearchPlugin.QuerySpec<T extends QueryBuilder> Specification of custom Query.
static class	SearchPlugin.ScoreFunctionSpec<T extends ScoreFunctionBuilder<T>> Specification of custom ScoreFunction.
static class	SearchPlugin.SearchExtensionSpec<W extends NamedWriteable,P> Specification of search time behavior extension like a custom MovAvgModel or ScoreFunction.
static class	SearchPlugin.SearchExtSpec<T extends SearchExtBuilder> Specification for a SearchExtBuilder which represents an additional section that can be parsed in a search request (within the ext element).
static class	SearchPlugin.SuggesterSpec<T extends SuggestionBuilder<T>> Specification for a Suggester.

Method Summary

Modifier and Type	Method and Description
default java.util.List<SearchPlugin.AggregationSpec>	getAggregations() The new Aggregations added by this plugin.
default java.util.List<FetchSubPhase>	getFetchSubPhases(SearchPlugin.FetchPhaseConstructionContext context) The new FetchSubPhases defined by this plugin.
default java.util.Map<java.lang.String,Highlighter>	getHighlighters() Get the Highlighters defined by this plugin.
default java.util.List<SearchPlugin.SearchExtensionSpec<MovAvgModel,MovAvgModel.AbstractModelParser>>	getMovingAverageModels() The new MovAvgModels defined by this plugin.
default java.util.List<SearchPlugin.PipelineAggregationSpec>	getPipelineAggregations() The new PipelineAggregators added by this plugin.
default java.util.List<SearchPlugin.QuerySpec<?>>	getQueries() The new Querys defined by this plugin.
default java.util.List<SearchPlugin.ScoreFunctionSpec<?>>	getScoreFunctions() The new ScoreFunctions defined by this plugin.
default java.util.List<SearchPlugin.SearchExtSpec<?>>	getSearchExts() The new SearchExtBuilders defined by this plugin.
default java.util.List<java.util.function.BiConsumer<SearchRequest,SearchResponse>>	getSearchResponseListeners() The new search response listeners in the form of BiConsumers added by this plugin.
default java.util.List<SearchPlugin.SearchExtensionSpec<SignificanceHeuristic,SignificanceHeuristicParser>>	getSignificanceHeuristics() The new SignificanceHeuristics defined by this plugin.
default java.util.List<SearchPlugin.SuggesterSpec<?>>	getSuggesters() The new Suggesters defined by this plugin.

Method Detail

getScoreFunctions

default java.util.List<SearchPlugin.ScoreFunctionSpec<?>> getScoreFunctions()

The new ScoreFunctions defined by this plugin.

getSignificanceHeuristics

default java.util.List<SearchPlugin.SearchExtensionSpec<SignificanceHeuristic,SignificanceHeuristicParser>> getSignificanceHeuristics()

The new SignificanceHeuristics defined by this plugin. SignificanceHeuristics are used by the SignificantTerms aggregation to pick which terms are significant for a given query.

getMovingAverageModels

default java.util.List<SearchPlugin.SearchExtensionSpec<MovAvgModel,MovAvgModel.AbstractModelParser>> getMovingAverageModels()

The new MovAvgModels defined by this plugin. MovAvgModels are used by the MovAvgPipelineAggregator to model trends in data.

getFetchSubPhases

default java.util.List<FetchSubPhase> getFetchSubPhases(SearchPlugin.FetchPhaseConstructionContext context)

The new FetchSubPhases defined by this plugin.

getSearchExts

default java.util.List<SearchPlugin.SearchExtSpec<?>> getSearchExts()

The new SearchExtBuilders defined by this plugin.

getHighlighters

default java.util.Map<java.lang.String,Highlighter> getHighlighters()

Get the Highlighters defined by this plugin.

getSuggesters

default java.util.List<SearchPlugin.SuggesterSpec<?>> getSuggesters()

The new Suggesters defined by this plugin.

getQueries

default java.util.List<SearchPlugin.QuerySpec<?>> getQueries()

The new Querys defined by this plugin.

getAggregations

default java.util.List<SearchPlugin.AggregationSpec> getAggregations()

The new Aggregations added by this plugin.

getPipelineAggregations

default java.util.List<SearchPlugin.PipelineAggregationSpec> getPipelineAggregations()

The new PipelineAggregators added by this plugin.

getSearchResponseListeners

default java.util.List<java.util.function.BiConsumer<SearchRequest,SearchResponse>> getSearchResponseListeners()

The new search response listeners in the form of BiConsumers added by this plugin. The listeners are invoked on the coordinating node, at the very end of the search request. This provides a convenient location if you wish to inspect/modify the final response (took time, etc). The BiConsumers are passed the original SearchRequest and the final SearchResponse