Module org.elasticsearch.server

Package org.elasticsearch.plugins

Interface ActionPlugin

All Known Subinterfaces:

RestServerActionPlugin, SystemIndexPlugin

public interface ActionPlugin

An additional extension point for Plugins that extends Elasticsearch's scripting functionality. Implement it like this:

   {@literal @}Override
   public List<ActionHandler<?, ?>> getActions() {
       return List.of(new ActionHandler<>(ReindexAction.INSTANCE, TransportReindexAction.class),
               new ActionHandler<>(UpdateByQueryAction.INSTANCE, TransportUpdateByQueryAction.class),
               new ActionHandler<>(DeleteByQueryAction.INSTANCE, TransportDeleteByQueryAction.class),
               new ActionHandler<>(RethrottleAction.INSTANCE, TransportRethrottleAction.class));
   }
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ActionPlugin.ActionHandler<Request extends ActionRequest,Response extends ActionResponse>

Method Summary

Modifier and Type	Method	Description
default Collection<ActionFilter>	getActionFilters()	ActionType filters added by this plugin.
default Collection<ActionPlugin.ActionHandler<? extends ActionRequest,? extends ActionResponse>>	getActions()	Actions added by this plugin.
default Collection<MappedActionFilter>	getMappedActionFilters()	Action filters applying to a single action added by this plugin.
default Collection<RestHandler>	getRestHandlers(Settings settings, NamedWriteableRegistry namedWriteableRegistry, RestController restController, ClusterSettings clusterSettings, IndexScopedSettings indexScopedSettings, SettingsFilter settingsFilter, IndexNameExpressionResolver indexNameExpressionResolver, Supplier<DiscoveryNodes> nodesInCluster, Predicate<NodeFeature> clusterSupportsFeature)	Rest handlers added by this plugin.
default Collection<RestHeaderDefinition>	getRestHeaders()	Returns headers which should be copied through rest requests on to internal requests.
default Collection<String>	getTaskHeaders()	Returns headers which should be copied from internal requests into tasks.
default Collection<RequestValidators.RequestValidator<IndicesAliasesRequest>>	indicesAliasesRequestValidators()
default Collection<RequestValidators.RequestValidator<PutMappingRequest>>	mappingRequestValidators()	Returns a collection of validators that are used by RequestValidators to validate a PutMappingRequest before the executing it.

Method Details

getActions

default Collection<ActionPlugin.ActionHandler<? extends ActionRequest,? extends ActionResponse>> getActions()

Actions added by this plugin.

getActionFilters

default Collection<ActionFilter> getActionFilters()

ActionType filters added by this plugin.

getMappedActionFilters

default Collection<MappedActionFilter> getMappedActionFilters()

Action filters applying to a single action added by this plugin.

getRestHandlers

default Collection<RestHandler> getRestHandlers(Settings settings,
 NamedWriteableRegistry namedWriteableRegistry,
 RestController restController,
 ClusterSettings clusterSettings,
 IndexScopedSettings indexScopedSettings,
 SettingsFilter settingsFilter,
 IndexNameExpressionResolver indexNameExpressionResolver,
 Supplier<DiscoveryNodes> nodesInCluster,
 Predicate<NodeFeature> clusterSupportsFeature)

Rest handlers added by this plugin.

getRestHeaders

default Collection<RestHeaderDefinition> getRestHeaders()

Returns headers which should be copied through rest requests on to internal requests.

getTaskHeaders

default Collection<String> getTaskHeaders()

Returns headers which should be copied from internal requests into tasks.

mappingRequestValidators

default Collection<RequestValidators.RequestValidator<PutMappingRequest>> mappingRequestValidators()

Returns a collection of validators that are used by RequestValidators to validate a PutMappingRequest before the executing it.

indicesAliasesRequestValidators

default Collection<RequestValidators.RequestValidator<IndicesAliasesRequest>> indicesAliasesRequestValidators()