Module org.elasticsearch.server

Package org.elasticsearch.cluster.coordination

Record Class JoinTask

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.coordination.JoinTask

All Implemented Interfaces:

ClusterStateTaskListener

public record JoinTask(List<JoinTask.NodeJoinTask> nodeJoinTasks, boolean isBecomingMaster, long term)
extends Record
implements ClusterStateTaskListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	JoinTask.NodeJoinTask

Constructor Summary

Constructors

Constructor	Description
JoinTask(List<JoinTask.NodeJoinTask> nodeJoinTasks, boolean isBecomingMaster, long term)	Creates an instance of a JoinTask record class.

Method Summary

Modifier and Type	Method	Description
static JoinTask	completingElection(Stream<JoinTask.NodeJoinTask> nodeJoinTaskStream, long term)
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.
boolean	isBecomingMaster()	Returns the value of the isBecomingMaster record component.
int	nodeCount()
List<JoinTask.NodeJoinTask>	nodeJoinTasks()	Returns the value of the nodeJoinTasks record component.
Iterable<DiscoveryNode>	nodes()
void	onFailure(Exception e)	A callback for when task execution fails.
static JoinTask	singleNode(DiscoveryNode node, JoinReason reason, ActionListener<Void> listener, long term)
long	term()	Returns the value of the term record component.
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

JoinTask

public JoinTask(List<JoinTask.NodeJoinTask> nodeJoinTasks,
 boolean isBecomingMaster,
 long term)

Creates an instance of a JoinTask record class.

Parameters:

nodeJoinTasks - the value for the nodeJoinTasks record component

isBecomingMaster - the value for the isBecomingMaster record component

term - the value for the term record component

Method Details

singleNode

public static JoinTask singleNode(DiscoveryNode node,
 JoinReason reason,
 ActionListener<Void> listener,
 long term)

completingElection

public static JoinTask completingElection(Stream<JoinTask.NodeJoinTask> nodeJoinTaskStream,
 long term)

nodeCount

public int nodeCount()

onFailure

public void onFailure(Exception e)

Description copied from interface: ClusterStateTaskListener

A callback for when task execution fails. May receive a NotMasterException if this node stopped being the master before this task was executed or a ProcessClusterEventTimeoutException if the task timed out before it was executed. If the task fails during execution then this method receives the corresponding exception. If the task executes successfully but the resulting cluster state publication fails then this method receives a FailedToCommitClusterStateException. If publication fails then a new master is elected and the update might or might not take effect, depending on whether or not the newly-elected master accepted the published state that failed to be committed.

Use MasterService.isPublishFailureException(java.lang.Exception) to detect the "expected" master failure cases if needed.

Implementations of this callback must not throw exceptions: an exception thrown here is logged by the master service at ERROR level and otherwise ignored, except in tests where it raises an AssertionError. If log-and-ignore is the right behaviour then implementations must do so themselves, typically using a more specific logger and at a less dramatic log level.

Specified by:

onFailure in interface ClusterStateTaskListener

toString

public 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

nodes

public Iterable<DiscoveryNode> nodes()

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

nodeJoinTasks

public List<JoinTask.NodeJoinTask> nodeJoinTasks()

Returns the value of the nodeJoinTasks record component.

Returns:

the value of the nodeJoinTasks record component

isBecomingMaster

public boolean isBecomingMaster()

Returns the value of the isBecomingMaster record component.

Returns:

the value of the isBecomingMaster record component

term

public long term()

Returns the value of the term record component.

Returns:

the value of the term record component