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
ConstructorsConstructorDescriptionDesiredShards(List<DesiredBalanceResponse.ShardView> current, DesiredBalanceResponse.ShardAssignmentView desired) Creates an instance of aDesiredShardsrecord class. -
Method Summary
Modifier and TypeMethodDescriptioncurrent()Returns the value of thecurrentrecord component.desired()Returns the value of thedesiredrecord component.final booleanIndicates whether some other object is "equal to" this one.from(StreamInput in) final inthashCode()Returns a hash code value for this object.final StringtoString()Returns a string representation of this record class.Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params) Create an iterator ofToXContentchunks for a REST response.voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent
toXContentChunkedV7Methods 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 aDesiredShardsrecord class.- Parameters:
current- the value for thecurrentrecord componentdesired- the value for thedesiredrecord component
-
-
Method Details
-
from
- Throws:
IOException
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContentChunked
Description copied from interface:ChunkedToXContentCreate an iterator ofToXContentchunks for a REST response. Each chunk is serialized with the sameXContentBuilderandToXContent.Params, which is also the same as theToXContent.Paramspassed as theparamsargument. 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 alsoChunkedToXContentHelperfor 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:
toXContentChunkedin 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 thecurrentrecord component.- Returns:
- the value of the
currentrecord component
-
desired
Returns the value of thedesiredrecord component.- Returns:
- the value of the
desiredrecord component
-