- 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 -
Method Summary
Modifier and TypeMethodDescriptiondefault Collection<ActionFilter> ActionType filters added by this plugin.default Collection<ActionPlugin.ActionHandler> Actions added by this plugin.default Collection<MappedActionFilter> 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> Returns headers which should be copied through rest requests on to internal requests.default Collection<String> Returns headers which should be copied from internal requests into tasks.Returns a collection of validators that are used byRequestValidatorsto validate aPutMappingRequestbefore the executing it.
-
Method Details
-
getActions
Actions added by this plugin. -
getActionFilters
ActionType filters added by this plugin. -
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
Returns headers which should be copied through rest requests on to internal requests. -
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 byRequestValidatorsto validate aPutMappingRequestbefore the executing it. -
indicesAliasesRequestValidators
default Collection<RequestValidators.RequestValidator<IndicesAliasesRequest>> indicesAliasesRequestValidators()
-