Module org.elasticsearch.server
Package org.elasticsearch.reservedstate
Interface ReservedProjectStateHandler<T>
- Type Parameters:
T- The type used to represent the state update
- All Superinterfaces:
ReservedStateHandler<T>
- All Known Implementing Classes:
ReservedComposableIndexTemplateAction,ReservedPipelineAction
ReservedStateHandler for updating project-specific cluster state.-
Field Summary
Fields inherited from interface org.elasticsearch.reservedstate.ReservedStateHandler
RESERVED_CLUSTER_STATE_HANDLER_IGNORED_TIMEOUT -
Method Summary
Modifier and TypeMethodDescriptiontransform(ProjectId projectId, T source, TransformState prevState) The transformation method implemented by the handler.Methods inherited from interface org.elasticsearch.reservedstate.ReservedStateHandler
dependencies, fromXContent, name, optionalDependencies, validate
-
Method Details
-
transform
The transformation method implemented by the handler.The transform method of the handler should apply the necessary changes to the cluster state as it normally would in a REST handler. One difference is that the transform method in an reserved state handler must perform all CRUD operations of the cluster state in one go. For that reason, we supply a wrapper class to the cluster state called
TransformState, which contains the current cluster state as well as any previous keys set by this handler on prior invocation.- Parameters:
projectId- The project id for the update state contentsource- The parsed information specific to this handler from the combined cluster state contentprevState- The previous cluster state and keys set by this handler (if any)- Returns:
- The modified state and the current keys set by this handler
- Throws:
Exception
-