Module org.elasticsearch.server

Package org.elasticsearch.action.admin.cluster.allocation

Record Class DesiredBalanceResponse.ShardAssignmentView

java.lang.Object

java.lang.Record

org.elasticsearch.action.admin.cluster.allocation.DesiredBalanceResponse.ShardAssignmentView

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

Enclosing class:

DesiredBalanceResponse

public static record DesiredBalanceResponse.ShardAssignmentView(Set<String> nodeIds, int total, int unassigned, int ignored)
extends Record
implements Writeable, ToXContentObject

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

Modifier and Type	Field	Description
static final DesiredBalanceResponse.ShardAssignmentView	EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ShardAssignmentView(Set<String> nodeIds, int total, int unassigned, int ignored)	Creates an instance of a ShardAssignmentView 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 DesiredBalanceResponse.ShardAssignmentView	from(StreamInput in)
final int	hashCode()	Returns a hash code value for this object.
int	ignored()	Returns the value of the ignored record component.
Set<String>	nodeIds()	Returns the value of the nodeIds record component.
final String	toString()	Returns a string representation of this record class.
int	total()	Returns the value of the total record component.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
int	unassigned()	Returns the value of the unassigned record component.
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

Field Details

EMPTY

public static final DesiredBalanceResponse.ShardAssignmentView EMPTY

Constructor Details

ShardAssignmentView

public ShardAssignmentView(Set<String> nodeIds,
 int total,
 int unassigned,
 int ignored)

Creates an instance of a ShardAssignmentView record class.

Parameters:

nodeIds - the value for the nodeIds record component

total - the value for the total record component

unassigned - the value for the unassigned record component

ignored - the value for the ignored record component

Method Details

from

public static DesiredBalanceResponse.ShardAssignmentView from(StreamInput in)
                                                       throws IOException

Throws:

IOException

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

toXContent

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

Specified by:

toXContent in interface ToXContent

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.

nodeIds

public Set<String> nodeIds()

Returns the value of the nodeIds record component.

Returns:

the value of the nodeIds record component

total

public int total()

Returns the value of the total record component.

Returns:

the value of the total record component

unassigned

public int unassigned()

Returns the value of the unassigned record component.

Returns:

the value of the unassigned record component

ignored

public int ignored()

Returns the value of the ignored record component.

Returns:

the value of the ignored record component