Package org.elasticsearch.plugins
Interface SystemIndexPlugin
- All Superinterfaces:
ActionPlugin
public interface SystemIndexPlugin extends ActionPlugin
Plugin for defining system indices. Extends
ActionPlugin
because system indices must be accessed via APIs
added by the plugin that owns the system index, rather than standard APIs.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.plugins.ActionPlugin
ActionPlugin.ActionHandler<Request extends ActionRequest,Response extends ActionResponse>
-
Method Summary
Modifier and Type Method Description default java.util.Collection<SystemIndexDescriptor>
getSystemIndexDescriptors(Settings settings)
Returns aCollection
ofSystemIndexDescriptor
s that describe this plugin's system indices, including name, mapping, and settings.Methods inherited from interface org.elasticsearch.plugins.ActionPlugin
getActionFilters, getActions, getClientActions, getRestHandlers, getRestHandlerWrapper, getRestHeaders, getTaskHeaders, indicesAliasesRequestValidators, mappingRequestValidators
-
Method Details
-
getSystemIndexDescriptors
Returns aCollection
ofSystemIndexDescriptor
s that describe this plugin's system indices, including name, mapping, and settings.- Parameters:
settings
- The node's settings- Returns:
- Descriptions of the system indices managed by this plugin.
-