Module org.elasticsearch.server
Record Class DesiredBalanceResponse.DesiredShards
java.lang.Object
java.lang.Record
org.elasticsearch.action.admin.cluster.allocation.DesiredBalanceResponse.DesiredShards
- All Implemented Interfaces:
Writeable
,ChunkedToXContent
,ChunkedToXContentObject
- Enclosing class:
- DesiredBalanceResponse
public static record DesiredBalanceResponse.DesiredShards(List<DesiredBalanceResponse.ShardView> current, DesiredBalanceResponse.ShardAssignmentView desired)
extends Record
implements Writeable, ChunkedToXContentObject
-
Nested Class Summary
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.common.xcontent.ChunkedToXContent
EMPTY
-
Constructor Summary
ConstructorDescriptionDesiredShards
(List<DesiredBalanceResponse.ShardView> current, DesiredBalanceResponse.ShardAssignmentView desired) Creates an instance of aDesiredShards
record class. -
Method Summary
Modifier and TypeMethodDescriptioncurrent()
Returns the value of thecurrent
record component.desired()
Returns the value of thedesired
record component.final boolean
Indicates whether some other object is "equal to" this one.from
(StreamInput in) final int
hashCode()
Returns a hash code value for this object.final String
toString()
Returns a string representation of this record class.Iterator<? extends ToXContent>
toXContentChunked
(ToXContent.Params params) Create an iterator ofToXContent
chunks for a REST response.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.common.xcontent.ChunkedToXContent
toXContentChunkedV7
Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContentObject
isFragment
-
Constructor Details
-
DesiredShards
public DesiredShards(List<DesiredBalanceResponse.ShardView> current, DesiredBalanceResponse.ShardAssignmentView desired) Creates an instance of aDesiredShards
record class.- Parameters:
current
- the value for thecurrent
record componentdesired
- the value for thedesired
record component
-
-
Method Details
-
from
- Throws:
IOException
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
toXContentChunked
Description copied from interface:ChunkedToXContent
Create an iterator ofToXContent
chunks for a REST response. Each chunk is serialized with the sameXContentBuilder
andToXContent.Params
, which is also the same as theToXContent.Params
passed as theparams
argument. For best results, all chunks should beO(1)
size. The last chunk in the iterator must always yield at least one byte of output. See alsoChunkedToXContentHelper
for some handy utilities.Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.
- Specified by:
toXContentChunked
in interfaceChunkedToXContent
- Returns:
- iterator over chunks of
ToXContent
-
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. -
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. -
equals
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 withObjects::equals(Object,Object)
. -
current
Returns the value of thecurrent
record component.- Returns:
- the value of the
current
record component
-
desired
Returns the value of thedesired
record component.- Returns:
- the value of the
desired
record component
-