Package org.elasticsearch.indices
Class SystemIndices.Feature
org.elasticsearch.indices.SystemIndices.Feature
- Enclosing class:
- SystemIndices
public static class SystemIndices.Feature
extends
Class holding a description of a stateful feature.
-
Constructor Summary
ConstructorDescriptionname, description, <SystemIndexDescriptor> indexDescriptors)
Construct a Feature using the default clean-up functionname, description, <SystemIndexDescriptor> indexDescriptors, <SystemDataStreamDescriptor> dataStreamDescriptors)
Construct a Feature using the default clean-up functiondescription, <SystemIndexDescriptor> indexDescriptors, <SystemDataStreamDescriptor> dataStreamDescriptors, <AssociatedIndexDescriptor> associatedIndexDescriptors, TriConsumer<ClusterService,Client,ActionListener<ResetFeatureStateResponse.ResetFeatureStateStatus>> cleanUpFunction)
Construct a Feature with a custom cleanup function -
Method Summary
Modifier and TypeMethodDescriptionstatic void
<? extends IndexPatternMatcher> indexDescriptors, <? extends IndexPatternMatcher> associatedIndexDescriptors, name, ClusterService clusterService, Client client, ActionListener<ResetFeatureStateResponse.ResetFeatureStateStatus> listener)
Clean up the state of a featureTriConsumer<ClusterService,Client,ActionListener<ResetFeatureStateResponse.ResetFeatureStateStatus>>
Methods inherited from class java.lang.
, , , , , , , , , ,
-
Constructor Details
-
Feature
public Feature( description, <SystemIndexDescriptor> indexDescriptors, <SystemDataStreamDescriptor> dataStreamDescriptors, <AssociatedIndexDescriptor> associatedIndexDescriptors, TriConsumer<ClusterService,Client,ActionListener<ResetFeatureStateResponse.ResetFeatureStateStatus>> cleanUpFunction)Construct a Feature with a custom cleanup function- Parameters:
description
- Description of the featureindexDescriptors
- Collection of objects describing system indices for this featuredataStreamDescriptors
- Collection of objects describing system data streams for this featureassociatedIndexDescriptors
- Collection of objects describing associated indices for this featurecleanUpFunction
- A function that will clean up the feature's state
-
Feature
Construct a Feature using the default clean-up function- Parameters:
name
- Name of the feature, used in loggingdescription
- Description of the featureindexDescriptors
- Patterns describing system indices for this feature
-
Feature
public Feature( name, description, <SystemIndexDescriptor> indexDescriptors, <SystemDataStreamDescriptor> dataStreamDescriptors)Construct a Feature using the default clean-up function- Parameters:
name
- Name of the feature, used in loggingdescription
- Description of the featureindexDescriptors
- Patterns describing system indices for this featuredataStreamDescriptors
- Collection of objects describing system data streams for this feature
-
-
Method Details
-
getDescription
public getDescription() -
getIndexDescriptors
-
getDataStreamDescriptors
-
getAssociatedIndexDescriptors
-
getCleanUpFunction
public TriConsumer<ClusterService,Client,ActionListener<ResetFeatureStateResponse.ResetFeatureStateStatus>> getCleanUpFunction() -
cleanUpFeature
public static void cleanUpFeature(<? extends IndexPatternMatcher> indexDescriptors, <? extends IndexPatternMatcher> associatedIndexDescriptors, 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 indicesassociatedIndexDescriptors
- List of descriptors of a feature's associated indicesname
- Name of the feature, used in loggingclusterService
- A clusterService, for retrieving cluster metadataclient
- A client, for issuing delete requestslistener
- A listener to return success or failure of cleanup
-