Module org.elasticsearch.server

Package org.elasticsearch.index.shard

Record Class IndexShard.ShardFailure

java.lang.Object

java.lang.Record

org.elasticsearch.index.shard.IndexShard.ShardFailure

Enclosing class:

IndexShard

public static record IndexShard.ShardFailure(ShardRouting routing, String reason, Exception cause)
extends Record

Simple struct encapsulating a shard failure

See Also:

• IndexShard.addShardFailureCallback(Consumer)

Constructor Summary

Constructors

Constructor	Description
ShardFailure(ShardRouting routing, String reason, Exception cause)	Creates an instance of a ShardFailure record class.

Method Summary

Modifier and Type	Method	Description
Exception	cause()	Returns the value of the cause 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.
String	reason()	Returns the value of the reason record component.
ShardRouting	routing()	Returns the value of the routing 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

ShardFailure

public ShardFailure(ShardRouting routing,
 String reason,
 @Nullable
 Exception cause)

Creates an instance of a ShardFailure record class.

Parameters:

routing - the value for the routing record component

reason - the value for the reason record component

cause - the value for the cause 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.

routing

public ShardRouting routing()

Returns the value of the routing record component.

Returns:

the value of the routing record component

reason

public String reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component

cause

@Nullable
public Exception cause()

Returns the value of the cause record component.

Returns:

the value of the cause record component