Package org.opensearch.plugins

Support for extending OpenSearch by providing java code that is loaded by a child classloader. See Plugin.

Interface Summary

Interface	Description
ActionPlugin	An additional extension point for Plugins that extends OpenSearch's scripting functionality.
AnalysisPlugin	An additional extension point for Plugins that extends OpenSearch's analysis functionality.
CircuitBreakerPlugin	An extension point for Plugin implementations to add custom circuit breakers
ClusterPlugin	An extension point for Plugin implementations to customer behavior of cluster management.
DiscoveryPlugin	An additional extension point for Plugins that extends OpenSearch's discovery functionality.
EnginePlugin	A plugin that provides alternative engine implementations.
ExtensiblePlugin	An extension point for Plugin implementations to be themselves extensible.
ExtensiblePlugin.ExtensionLoader
IndexStorePlugin	A plugin that provides alternative directory implementations.
IndexStorePlugin.DirectoryFactory	An interface that describes how to create a new directory instance per shard.
IndexStorePlugin.RecoveryStateFactory	An interface that allows to create a new RecoveryState per shard.
IngestPlugin	An extension point for Plugin implementations to add custom ingest processors
MapperPlugin	An extension point for Plugin implementations to add custom mappers
NetworkPlugin	Plugin for extending network and transport related classes
PersistentTaskPlugin	Plugin for registering persistent tasks executors.
ReloadablePlugin	An extension point for Plugins that can be reloaded.
RepositoryPlugin	An extension point for Plugin implementations to add custom snapshot repositories.
ScriptPlugin	An additional extension point for Plugins that extends OpenSearch's scripting functionality.
SearchPlugin	Plugin for extending search time behavior.
SystemIndexPlugin	Plugin for defining system indices.

Class Summary

Class	Description
ActionPlugin.ActionHandler<Request extends ActionRequest,Response extends ActionResponse>
MetadataUpgrader	Upgrades Metadata on startup on behalf of installed Plugins
Platforms	Encapsulates platform-dependent methods for handling native components of plugins.
Plugin	An extension point allowing to plug in custom functionality.
PluginInfo	An in-memory representation of the plugin descriptor.
PluginsService
SearchPlugin.AggregationSpec	Specification for an Aggregation.
SearchPlugin.FetchPhaseConstructionContext	Context available during fetch phase construction.
SearchPlugin.PipelineAggregationSpec	Specification for a PipelineAggregator.
SearchPlugin.QuerySpec<T extends QueryBuilder>	Specification of custom Query.
SearchPlugin.RescorerSpec<T extends RescorerBuilder<T>>	Specification for a RescorerBuilder.
SearchPlugin.ScoreFunctionSpec<T extends ScoreFunctionBuilder<T>>	Specification of custom ScoreFunction.
SearchPlugin.SearchExtensionSpec<W extends NamedWriteable,P>	Specification of search time behavior extension like a custom MovAvgModel or ScoreFunction.
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).
SearchPlugin.SignificanceHeuristicSpec<T extends SignificanceHeuristic>	Specification of custom SignificanceHeuristic.
SearchPlugin.SortSpec<T extends SortBuilder<T>>	Specification of custom Sort.
SearchPlugin.SuggesterSpec<T extends SuggestionBuilder<T>>	Specification for a Suggester.