Module org.elasticsearch.server

Package org.elasticsearch.action.admin.cluster.node.shutdown

Record Class NodesRemovalPrevalidation.Result

java.lang.Object

java.lang.Record

org.elasticsearch.action.admin.cluster.node.shutdown.NodesRemovalPrevalidation.Result

Record Components:

reason - is nullable only for BWC between 8.6 and 8.7. In a fully-upgraded 8.7, it should always be non-null.

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

Enclosing class:

NodesRemovalPrevalidation

public static record NodesRemovalPrevalidation.Result(boolean isSafe, NodesRemovalPrevalidation.Reason reason, String message)
extends Record
implements ToXContentObject, Writeable

The prevalidation result of a node.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Result(boolean isSafe, NodesRemovalPrevalidation.Reason reason, String message)	Creates an instance of a Result record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static NodesRemovalPrevalidation.Result	fromXContent(XContentParser parser)
final int	hashCode()	Returns a hash code value for this object.
boolean	isSafe()	Returns the value of the isSafe record component.
String	message()	Returns the value of the message record component.
static NodesRemovalPrevalidation.Result	readFrom(StreamInput in)
NodesRemovalPrevalidation.Reason	reason()	Returns the value of the reason record component.
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

Result

public Result(boolean isSafe,
 @Nullable
 NodesRemovalPrevalidation.Reason reason,
 String message)

Creates an instance of a Result record class.

Parameters:

isSafe - the value for the isSafe record component

reason - the value for the reason record component

message - the value for the message record component

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

readFrom

public static NodesRemovalPrevalidation.Result readFrom(StreamInput in)
                                                 throws IOException

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static NodesRemovalPrevalidation.Result fromXContent(XContentParser parser)
                                                     throws IOException

Throws:

IOException

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. 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.

isSafe

public boolean isSafe()

Returns the value of the isSafe record component.

Returns:

the value of the isSafe record component

reason

@Nullable
public NodesRemovalPrevalidation.Reason reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component