Module org.elasticsearch.server

Package org.elasticsearch.cluster

Record Class ClusterStateTaskExecutor.BatchExecutionContext<T extends ClusterStateTaskListener>

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.ClusterStateTaskExecutor.BatchExecutionContext<T>

Record Components:

initialState - The initial cluster state on which the tasks should be executed.

taskContexts - A ClusterStateTaskExecutor.TaskContext for each task in the batch. Implementations must complete every context in the list.

dropHeadersContextSupplier - Supplies a context (a resource for use in a try-with-resources block) which captures and drops any emitted response headers, for cases where things like deprecation warnings may be emitted but cannot be associated with any specific task.

Enclosing interface:

ClusterStateTaskExecutor<T extends ClusterStateTaskListener>

public static record ClusterStateTaskExecutor.BatchExecutionContext<T extends ClusterStateTaskListener>(ClusterState initialState, List<? extends ClusterStateTaskExecutor.TaskContext<T extends ClusterStateTaskListener>> taskContexts, Supplier<Releasable> dropHeadersContextSupplier)
extends Record

Encapsulates the context in which a batch of tasks executes.

Constructor Summary

Constructors

Constructor	Description
BatchExecutionContext(ClusterState initialState, List<? extends ClusterStateTaskExecutor.TaskContext<T>> taskContexts, Supplier<Releasable> dropHeadersContextSupplier)	Creates an instance of a BatchExecutionContext record class.

Method Summary

Modifier and Type	Method	Description
Releasable	dropHeadersContext()	Creates a context (a resource for use in a try-with-resources block) which captures and drops any emitted response headers, for cases where things like deprecation warnings may be emitted but cannot be associated with any specific task.
Supplier<Releasable>	dropHeadersContextSupplier()	Returns the value of the dropHeadersContextSupplier record component.
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.
ClusterState	initialState()	Returns the value of the initialState record component.
List<? extends ClusterStateTaskExecutor.TaskContext<T>>	taskContexts()	Returns the value of the taskContexts 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

BatchExecutionContext

public BatchExecutionContext(ClusterState initialState,
 List<? extends ClusterStateTaskExecutor.TaskContext<T>> taskContexts,
 Supplier<Releasable> dropHeadersContextSupplier)

Creates an instance of a BatchExecutionContext record class.

Parameters:

initialState - the value for the initialState record component

taskContexts - the value for the taskContexts record component

dropHeadersContextSupplier - the value for the dropHeadersContextSupplier record component

Method Details

dropHeadersContext

public Releasable dropHeadersContext()

Creates a context (a resource for use in a try-with-resources block) which captures and drops any emitted response headers, for cases where things like deprecation warnings may be emitted but cannot be associated with any specific task.

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.

initialState

public ClusterState initialState()

Returns the value of the initialState record component.

Returns:

the value of the initialState record component

taskContexts

public List<? extends ClusterStateTaskExecutor.TaskContext<T>> taskContexts()

Returns the value of the taskContexts record component.

Returns:

the value of the taskContexts record component

dropHeadersContextSupplier

public Supplier<Releasable> dropHeadersContextSupplier()

Returns the value of the dropHeadersContextSupplier record component.

Returns:

the value of the dropHeadersContextSupplier record component