Package org.elasticsearch.cluster

Record Class ClusterStateTaskExecutor.SuccessIgnoringPublishListener

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.ClusterStateTaskExecutor.SuccessIgnoringPublishListener

All Implemented Interfaces:

ActionListener<ClusterState>

Enclosing interface:

ClusterStateTaskExecutor<T extends ClusterStateTaskListener>

public static record ClusterStateTaskExecutor.SuccessIgnoringPublishListener(ClusterStateTaskListener task)
extends Record
implements ActionListener<ClusterState>

Tasks that listen for acks typically do not care about a successfully-completed publication, but must still handle publication failures. This adapter makes that pattern easy.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.action.ActionListener

ActionListener.Delegating<Response,DelegateResponse>, ActionListener.DelegatingActionListener<T>, ActionListener.DelegatingFailureActionListener<T,R>, ActionListener.MappedActionListener<Response,MappedResponse>, ActionListener.RunAfterActionListener<T>, ActionListener.RunBeforeActionListener<T>

Field Summary

Fields inherited from interface org.elasticsearch.action.ActionListener

NOOP

Constructor Summary

Constructors

Constructor	Description
SuccessIgnoringPublishListener(ClusterStateTaskListener task)	Creates an instance of a SuccessIgnoringPublishListener 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.
void	onFailure(Exception e)	A failure caused by an exception at some phase of the task.
void	onResponse(ClusterState clusterState)	Handle action response.
ClusterStateTaskListener	task()	Returns the value of the task 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

Methods inherited from interface org.elasticsearch.action.ActionListener

delegateFailure, delegateResponse, map

Constructor Details

SuccessIgnoringPublishListener

public SuccessIgnoringPublishListener(ClusterStateTaskListener task)

Creates an instance of a SuccessIgnoringPublishListener record class.

Parameters:

task - the value for the task record component

Method Details

onResponse

public void onResponse(ClusterState clusterState)

Description copied from interface: ActionListener

Handle action response. This response may constitute a failure or a success but it is up to the listener to make that decision.

Specified by:

onResponse in interface ActionListener<ClusterState>

onFailure

public void onFailure(Exception e)

Description copied from interface: ActionListener

A failure caused by an exception at some phase of the task.

Specified by:

onFailure in interface ActionListener<ClusterState>

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.

task

public ClusterStateTaskListener task()

Returns the value of the task record component.

Returns:

the value of the task record component