Module org.elasticsearch.server

Package org.elasticsearch.indices

Class SystemIndices.Feature

java.lang.Object

org.elasticsearch.indices.SystemIndices.Feature

Enclosing class:

SystemIndices

public static class SystemIndices.Feature
extends Object

Describes an Elasticsearch system feature that keeps state in protected indices and data streams.

This is an internal class that closely follows the model of SystemIndexPlugin. See that class’s documents for high-level details about what constitutes a system feature.

This class has a static cleanUpFeature(Collection, Collection, String, ClusterService, Client, ActionListener) method that is the default implementation for resetting feature state.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SystemIndices.Feature.MigrationCompletionHandler	Type for the handler that's invoked when all of a feature's system indices have been migrated.
static interface	SystemIndices.Feature.MigrationPreparationHandler	Type for the handler that's invoked prior to migrating a Feature's system indices.

Constructor Summary

Constructors

Constructor	Description
Feature(String name, String description, Collection<SystemIndexDescriptor> indexDescriptors)	Construct a Feature using the default clean-up function
Feature(String name, String description, Collection<SystemIndexDescriptor> indexDescriptors, Collection<SystemDataStreamDescriptor> dataStreamDescriptors)	Construct a Feature using the default clean-up function
Feature(String name, String description, Collection<SystemIndexDescriptor> indexDescriptors, Collection<SystemDataStreamDescriptor> dataStreamDescriptors, Collection<AssociatedIndexDescriptor> associatedIndexDescriptors, TriConsumer<ClusterService,Client,ActionListener<ResetFeatureStateResponse.ResetFeatureStateStatus>> cleanUpFunction, SystemIndices.Feature.MigrationPreparationHandler preMigrationFunction, SystemIndices.Feature.MigrationCompletionHandler postMigrationFunction)	Construct a Feature with a custom cleanup function

Method Summary

Modifier and Type	Method	Description
static void	cleanUpFeature(Collection<SystemIndexDescriptor> indexDescriptors, Collection<? extends IndexPatternMatcher> associatedIndexDescriptors, String name, ClusterService clusterService, Client client, ActionListener<ResetFeatureStateResponse.ResetFeatureStateStatus> listener)	Clean up the state of a feature
static SystemIndices.Feature	fromSystemIndexPlugin(SystemIndexPlugin plugin, Settings settings)	Creates a SystemIndices.Feature from a SystemIndexPlugin.
Collection<AssociatedIndexDescriptor>	getAssociatedIndexDescriptors()
TriConsumer<ClusterService,Client,ActionListener<ResetFeatureStateResponse.ResetFeatureStateStatus>>	getCleanUpFunction()
Collection<SystemDataStreamDescriptor>	getDataStreamDescriptors()
String	getDescription()
Collection<SystemIndexDescriptor>	getIndexDescriptors()
String	getName()
SystemIndices.Feature.MigrationCompletionHandler	getPostMigrationFunction()
SystemIndices.Feature.MigrationPreparationHandler	getPreMigrationFunction()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Feature

public Feature(String name,
 String description,
 Collection<SystemIndexDescriptor> indexDescriptors,
 Collection<SystemDataStreamDescriptor> dataStreamDescriptors,
 Collection<AssociatedIndexDescriptor> associatedIndexDescriptors,
 TriConsumer<ClusterService,Client,ActionListener<ResetFeatureStateResponse.ResetFeatureStateStatus>> cleanUpFunction,
 SystemIndices.Feature.MigrationPreparationHandler preMigrationFunction,
 SystemIndices.Feature.MigrationCompletionHandler postMigrationFunction)

Construct a Feature with a custom cleanup function

Parameters:

name - The name of the feature

description - Description of the feature

indexDescriptors - Collection of objects describing system indices for this feature

dataStreamDescriptors - Collection of objects describing system data streams for this feature

associatedIndexDescriptors - Collection of objects describing associated indices for this feature

cleanUpFunction - A function that will clean up the feature's state

preMigrationFunction - A function that will be called prior to upgrading any of this plugin's system indices

postMigrationFunction - A function that will be called after upgrading all of this plugin's system indices

Feature

public Feature(String name,
 String description,
 Collection<SystemIndexDescriptor> indexDescriptors)

Construct a Feature using the default clean-up function

Parameters:

name - Name of the feature, used in logging

description - Description of the feature

indexDescriptors - Patterns describing system indices for this feature

Feature

public Feature(String name,
 String description,
 Collection<SystemIndexDescriptor> indexDescriptors,
 Collection<SystemDataStreamDescriptor> dataStreamDescriptors)

Construct a Feature using the default clean-up function

Parameters:

name - Name of the feature, used in logging

description - Description of the feature

indexDescriptors - Patterns describing system indices for this feature

dataStreamDescriptors - Collection of objects describing system data streams for this feature

Method Details

fromSystemIndexPlugin

public static SystemIndices.Feature fromSystemIndexPlugin(SystemIndexPlugin plugin,
 Settings settings)

Creates a SystemIndices.Feature from a SystemIndexPlugin.

Parameters:

plugin - The SystemIndexPlugin that adds this feature.

settings - Node-level settings, as this may impact the descriptors returned by the plugin.

Returns:

A SystemIndices.Feature which represents the feature added by the given plugin.

getDescription

public String getDescription()

getIndexDescriptors

public Collection<SystemIndexDescriptor> getIndexDescriptors()

getDataStreamDescriptors

public Collection<SystemDataStreamDescriptor> getDataStreamDescriptors()

getAssociatedIndexDescriptors

public Collection<AssociatedIndexDescriptor> getAssociatedIndexDescriptors()

getCleanUpFunction

public TriConsumer<ClusterService,Client,ActionListener<ResetFeatureStateResponse.ResetFeatureStateStatus>> getCleanUpFunction()

getName

public String getName()

getPreMigrationFunction

public SystemIndices.Feature.MigrationPreparationHandler getPreMigrationFunction()

getPostMigrationFunction

public SystemIndices.Feature.MigrationCompletionHandler getPostMigrationFunction()

cleanUpFeature

public static void cleanUpFeature(Collection<SystemIndexDescriptor> indexDescriptors,
 Collection<? extends IndexPatternMatcher> associatedIndexDescriptors,
 String name,
 ClusterService clusterService,
 Client client,
 ActionListener<ResetFeatureStateResponse.ResetFeatureStateStatus> listener)

Clean up the state of a feature

Parameters:

indexDescriptors - List of descriptors of a feature's system indices

associatedIndexDescriptors - List of descriptors of a feature's associated indices

name - Name of the feature, used in logging

clusterService - A clusterService, for retrieving cluster metadata

client - A client, for issuing delete requests

listener - A listener to return success or failure of cleanup