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<java.lang.String>
getAssociatedIndexPatterns()
Returns a list of index patterns for "associated indices": indices which depend on this plugin's system indices, but are not themselves system indices.java.lang.String
getFeatureDescription()
java.lang.String
getFeatureName()
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.
-
getFeatureName
java.lang.String getFeatureName()- Returns:
- The name of the feature, as used for specifying feature states in snapshot creation and restoration.
-
getFeatureDescription
java.lang.String getFeatureDescription()- Returns:
- A description of the feature, as used for the Get Snapshottable Features API.
-
getAssociatedIndexPatterns
default java.util.Collection<java.lang.String> getAssociatedIndexPatterns()Returns a list of index patterns for "associated indices": indices which depend on this plugin's system indices, but are not themselves system indices.- Returns:
- A list of index patterns which depend on the contents of this plugin's system indices, but are not themselves system indices
-