Package org.opensearch.search.pipeline.common

Class SearchPipelineCommonModulePlugin

java.lang.Object

org.opensearch.plugins.Plugin

org.opensearch.search.pipeline.common.SearchPipelineCommonModulePlugin

All Implemented Interfaces:

Closeable, AutoCloseable, SearchPipelinePlugin

public class SearchPipelineCommonModulePlugin
extends Plugin
implements SearchPipelinePlugin

Plugin providing common search request/response processors for use in search pipelines.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.plugins.SearchPipelinePlugin

SearchPipelinePlugin.Parameters

Constructor Summary

Constructors

Constructor	Description
SearchPipelineCommonModulePlugin()	No constructor needed, but build complains if we don't have a constructor with JavaDoc.

Method Summary

Modifier and Type	Method	Description
Map<String,Processor.Factory<SearchRequestProcessor>>	getRequestProcessors(SearchPipelinePlugin.Parameters parameters)	Returns a map of processor factories.
Map<String,Processor.Factory<SearchResponseProcessor>>	getResponseProcessors(SearchPipelinePlugin.Parameters parameters)
Map<String,Processor.Factory<SearchPhaseResultsProcessor>>	getSearchPhaseResultsProcessors(SearchPipelinePlugin.Parameters parameters)
List<Setting<?>>	getSettings()

Methods inherited from class org.opensearch.plugins.Plugin

additionalSettings, close, createComponents, createGuiceModules, getAdditionalIndexSettingProviders, getBootstrapChecks, getExecutorBuilders, getFeature, getGuiceServiceClasses, getIndexTemplateMetadataUpgrader, getNamedWriteables, getNamedXContent, getRoles, getSecureSettingFactory, getSettingsFilter, getSettingUpgraders, onIndexModule

Methods inherited from class java.lang.Object

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

Constructor Details

SearchPipelineCommonModulePlugin

public SearchPipelineCommonModulePlugin()

No constructor needed, but build complains if we don't have a constructor with JavaDoc.

Method Details

getSettings

public List<Setting<?>> getSettings()

Overrides:

getSettings in class Plugin

getRequestProcessors

public Map<String,Processor.Factory<SearchRequestProcessor>> getRequestProcessors(SearchPipelinePlugin.Parameters parameters)

Returns a map of processor factories.

Specified by:

getRequestProcessors in interface SearchPipelinePlugin

Parameters:

parameters - The parameters required for creating the processor factories.

Returns:

A map of processor factories, where the keys are the processor types and the values are the corresponding factory instances.

getResponseProcessors

public Map<String,Processor.Factory<SearchResponseProcessor>> getResponseProcessors(SearchPipelinePlugin.Parameters parameters)

Specified by:

getResponseProcessors in interface SearchPipelinePlugin

getSearchPhaseResultsProcessors

public Map<String,Processor.Factory<SearchPhaseResultsProcessor>> getSearchPhaseResultsProcessors(SearchPipelinePlugin.Parameters parameters)

Specified by:

getSearchPhaseResultsProcessors in interface SearchPipelinePlugin