Module org.elasticsearch.server

Package org.elasticsearch.reservedstate

Record Class TransformState

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

Constructors

Constructor	Description
TransformState(ClusterState state, Set<String> keys)
TransformState(ClusterState state, Set<String> keys, Consumer<ActionListener<NonStateTransformResult>> nonStateTransform)	Creates an instance of a TransformState record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Set<String>	keys()	Returns the value of the keys record component.
Consumer<ActionListener<NonStateTransformResult>>	nonStateTransform()	Returns the value of the nonStateTransform record component.
ClusterState	state()	Returns the value of the state record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

TransformState

public TransformState(ClusterState state,
 Set<String> keys)

TransformState

public TransformState(ClusterState state,
 Set<String> keys,
 Consumer<ActionListener<NonStateTransformResult>> nonStateTransform)

Creates an instance of a TransformState record class.

Parameters:

state - the value for the state record component

keys - the value for the keys record component

nonStateTransform - the value for the nonStateTransform record component

Method Details

toString

public final String 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.

Specified by:

toString in class Record

Returns:

a string representation of this object

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.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

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 with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

state

public ClusterState state()

Returns the value of the state record component.

Returns:

the value of the state record component

keys

public Set<String> keys()

Returns the value of the keys record component.

Returns:

the value of the keys record component

nonStateTransform

public Consumer<ActionListener<NonStateTransformResult>> nonStateTransform()

Returns the value of the nonStateTransform record component.

Returns:

the value of the nonStateTransform record component