Module org.elasticsearch.server

Package org.elasticsearch.action.admin.cluster.reroute

Class ClusterRerouteResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.admin.cluster.reroute.ClusterRerouteResponse

All Implemented Interfaces:

IsAcknowledgedSupplier, Writeable, ChunkedToXContent, ChunkedToXContentObject, RefCounted

public class ClusterRerouteResponse
extends ActionResponse
implements IsAcknowledgedSupplier, ChunkedToXContentObject

Response returned after a cluster reroute request

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

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 String	STATE_FIELD_DEPRECATION_MESSAGE

Fields inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

EMPTY

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Method Summary

Modifier and Type	Method	Description
RoutingExplanations	getExplanations()
ClusterState	getState()	Returns the cluster state resulted from the cluster reroute request execution
final boolean	isAcknowledged()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params outerParams)	Create an iterator of ToXContent chunks for a REST response.
Iterator<? extends ToXContent>	toXContentChunkedV7(ToXContent.Params outerParams)	Create an iterator of ToXContent chunks for a response to the RestApiVersion.V_7 API.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Field Details

STATE_FIELD_DEPRECATION_MESSAGE

public static final String STATE_FIELD_DEPRECATION_MESSAGE

See Also:

• Constant Field Values

Method Details

getState

public ClusterState getState()

Returns the cluster state resulted from the cluster reroute request execution

getExplanations

public RoutingExplanations getExplanations()

isAcknowledged

public final boolean isAcknowledged()

Specified by:

isAcknowledged in interface IsAcknowledgedSupplier

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

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params outerParams)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper 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 interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent

toXContentChunkedV7

public Iterator<? extends ToXContent> toXContentChunkedV7(ToXContent.Params outerParams)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a response to the RestApiVersion.V_7 API. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for some handy utilities.

Similar to ChunkedToXContent.toXContentChunked(org.elasticsearch.xcontent.ToXContent.Params) but for the RestApiVersion.V_7 API. By default this method delegates to ChunkedToXContent.toXContentChunked(org.elasticsearch.xcontent.ToXContent.Params).

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:

toXContentChunkedV7 in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent