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 void	cleanUpFeature(ClusterService clusterService, Client client, ActionListener<ResetFeatureStateResponse.ResetFeatureStateStatus> listener)	Cleans up the state of the feature by deleting system indices and associated indices.
default Collection<AssociatedIndexDescriptor>	getAssociatedIndexDescriptors()	Returns a list of descriptors for "associated indices": indices which depend on this plugin's system indices, but are not themselves system indices.
String	getFeatureDescription()
String	getFeatureName()
default Collection<SystemDataStreamDescriptor>	getSystemDataStreamDescriptors()
default Collection<SystemIndexDescriptor>	getSystemIndexDescriptors(Settings settings)	Returns a Collection of SystemIndexDescriptors 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

default Collection<SystemIndexDescriptor> getSystemIndexDescriptors(Settings settings)

Returns a Collection of SystemIndexDescriptors 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.

getSystemDataStreamDescriptors

default Collection<SystemDataStreamDescriptor> getSystemDataStreamDescriptors()

getFeatureName

String getFeatureName()

Returns:

The name of the feature, as used for specifying feature states in snapshot creation and restoration.

getFeatureDescription

String getFeatureDescription()

Returns:

A description of the feature, as used for the Get Snapshottable Features API.

getAssociatedIndexDescriptors

default Collection<AssociatedIndexDescriptor> getAssociatedIndexDescriptors()

Returns a list of descriptors for "associated indices": indices which depend on this plugin's system indices, but are not themselves system indices.

Returns:

A list of descriptors of indices which depend on the contents of this plugin's system indices, but are not themselves system indices

cleanUpFeature

default void cleanUpFeature(ClusterService clusterService,
 Client client,
 ActionListener<ResetFeatureStateResponse.ResetFeatureStateStatus> listener)

Cleans up the state of the feature by deleting system indices and associated indices. Override to do more for cleanup (e.g. cancelling tasks).

Parameters:

clusterService - Cluster service to provide cluster state

client - A client, for executing actions

listener - Listener for post-cleanup result