java.lang.Object
java.lang.Record
org.elasticsearch.reservedstate.TransformState
public record TransformState(ClusterState state, Set<String> keys, Consumer<ActionListener<NonStateTransformResult>> nonStateTransform)
extends Record
A
ClusterState
wrapper used by the ReservedClusterStateService to pass the
current state as well as previous keys set by an ReservedClusterStateHandler
to each transform
step of the cluster state update.
Each ReservedClusterStateHandler
can also provide a non cluster state transform consumer that should run after
the cluster state is fully validated. This allows for handlers to perform extra steps, like clearing caches or saving
other state outside the cluster state. The consumer, if provided, must return a NonStateTransformResult
with
the keys that will be saved as reserved in the cluster state.-
Constructor Summary
ConstructorDescriptionTransformState
(ClusterState state, Set<String> keys) TransformState
(ClusterState state, Set<String> keys, Consumer<ActionListener<NonStateTransformResult>> nonStateTransform) Creates an instance of aTransformState
record class. -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
Indicates whether some other object is "equal to" this one.final int
hashCode()
Returns a hash code value for this object.keys()
Returns the value of thekeys
record component.Returns the value of thenonStateTransform
record component.state()
Returns the value of thestate
record component.final String
toString()
Returns a string representation of this record class.
-
Constructor Details
-
TransformState
-
TransformState
public TransformState(ClusterState state, Set<String> keys, Consumer<ActionListener<NonStateTransformResult>> nonStateTransform) Creates an instance of aTransformState
record class.- Parameters:
state
- the value for thestate
record componentkeys
- the value for thekeys
record componentnonStateTransform
- the value for thenonStateTransform
record component
-
-
Method Details
-
toString
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components. -
hashCode
public final int hashCode()Returns a hash code value for this object. The value is derived from the hash code of each of the record components. -
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared withObjects::equals(Object,Object)
. -
state
Returns the value of thestate
record component.- Returns:
- the value of the
state
record component
-
keys
Returns the value of thekeys
record component.- Returns:
- the value of the
keys
record component
-
nonStateTransform
Returns the value of thenonStateTransform
record component.- Returns:
- the value of the
nonStateTransform
record component
-