Package org.elasticsearch.plugins
Interface SearchPlugin
-
public interface SearchPlugin
Plugin for extending search time behavior.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
SearchPlugin.AggregationSpec
Specification for anAggregation
.static class
SearchPlugin.FetchPhaseConstructionContext
Context available during fetch phase construction.static class
SearchPlugin.PipelineAggregationSpec
Specification for aPipelineAggregator
.static class
SearchPlugin.QuerySpec<T extends QueryBuilder>
Specification of customQuery
.static class
SearchPlugin.RescorerSpec<T extends RescorerBuilder<T>>
static class
SearchPlugin.ScoreFunctionSpec<T extends ScoreFunctionBuilder<T>>
Specification of customScoreFunction
.static class
SearchPlugin.SearchExtensionSpec<W extends NamedWriteable,P>
Specification of search time behavior extension like a customMovAvgModel
orScoreFunction
.static class
SearchPlugin.SearchExtSpec<T extends SearchExtBuilder>
Specification for aSearchExtBuilder
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 aSuggester
.
-
Method Summary
Modifier and Type Method Description default java.util.List<SearchPlugin.AggregationSpec>
getAggregations()
The newAggregation
s added by this plugin.default java.util.List<FetchSubPhase>
getFetchSubPhases(SearchPlugin.FetchPhaseConstructionContext context)
The newFetchSubPhase
s defined by this plugin.default java.util.Map<java.lang.String,Highlighter>
getHighlighters()
Get theHighlighter
s defined by this plugin.default java.util.List<SearchPlugin.SearchExtensionSpec<MovAvgModel,MovAvgModel.AbstractModelParser>>
getMovingAverageModels()
The newMovAvgModel
s defined by this plugin.default java.util.List<SearchPlugin.PipelineAggregationSpec>
getPipelineAggregations()
The newPipelineAggregator
s added by this plugin.default java.util.List<SearchPlugin.QuerySpec<?>>
getQueries()
The newQuery
s defined by this plugin.default java.util.List<SearchPlugin.RescorerSpec<?>>
getRescorers()
The newRescorer
s added by this plugin.default java.util.List<SearchPlugin.ScoreFunctionSpec<?>>
getScoreFunctions()
The newScoreFunction
s defined by this plugin.default java.util.List<SearchPlugin.SearchExtSpec<?>>
getSearchExts()
The newSearchExtBuilder
s defined by this plugin.default java.util.List<SearchPlugin.SearchExtensionSpec<SignificanceHeuristic,SignificanceHeuristicParser>>
getSignificanceHeuristics()
The newSignificanceHeuristic
s defined by this plugin.default java.util.List<SearchPlugin.SuggesterSpec<?>>
getSuggesters()
The newSuggester
s defined by this plugin.
-
-
-
Method Detail
-
getScoreFunctions
default java.util.List<SearchPlugin.ScoreFunctionSpec<?>> getScoreFunctions()
The newScoreFunction
s defined by this plugin.
-
getSignificanceHeuristics
default java.util.List<SearchPlugin.SearchExtensionSpec<SignificanceHeuristic,SignificanceHeuristicParser>> getSignificanceHeuristics()
The newSignificanceHeuristic
s defined by this plugin. SignificanceHeuristics are used by theSignificantTerms
aggregation to pick which terms are significant for a given query.
-
getMovingAverageModels
default java.util.List<SearchPlugin.SearchExtensionSpec<MovAvgModel,MovAvgModel.AbstractModelParser>> getMovingAverageModels()
The newMovAvgModel
s defined by this plugin. MovAvgModels are used by theMovAvgPipelineAggregator
to model trends in data.
-
getFetchSubPhases
default java.util.List<FetchSubPhase> getFetchSubPhases(SearchPlugin.FetchPhaseConstructionContext context)
The newFetchSubPhase
s defined by this plugin.
-
getSearchExts
default java.util.List<SearchPlugin.SearchExtSpec<?>> getSearchExts()
The newSearchExtBuilder
s defined by this plugin.
-
getHighlighters
default java.util.Map<java.lang.String,Highlighter> getHighlighters()
Get theHighlighter
s defined by this plugin.
-
getSuggesters
default java.util.List<SearchPlugin.SuggesterSpec<?>> getSuggesters()
The newSuggester
s defined by this plugin.
-
getQueries
default java.util.List<SearchPlugin.QuerySpec<?>> getQueries()
The newQuery
s defined by this plugin.
-
getAggregations
default java.util.List<SearchPlugin.AggregationSpec> getAggregations()
The newAggregation
s added by this plugin.
-
getPipelineAggregations
default java.util.List<SearchPlugin.PipelineAggregationSpec> getPipelineAggregations()
The newPipelineAggregator
s added by this plugin.
-
getRescorers
default java.util.List<SearchPlugin.RescorerSpec<?>> getRescorers()
The newRescorer
s added by this plugin.
-
-