Module org.elasticsearch.server
Class BaseNodesXContentResponse<TNodeResponse extends BaseNodeResponse>
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportResponse
org.elasticsearch.action.ActionResponse
org.elasticsearch.action.support.nodes.BaseNodesResponse<TNodeResponse>
org.elasticsearch.action.support.nodes.BaseNodesXContentResponse<TNodeResponse>
- All Implemented Interfaces:
Writeable,ChunkedToXContent,ChunkedToXContentObject,RefCounted
- Direct Known Subclasses:
NodesStatsResponse
public abstract class BaseNodesXContentResponse<TNodeResponse extends BaseNodeResponse>
extends BaseNodesResponse<TNodeResponse>
implements ChunkedToXContentObject
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse
ActionResponse.EmptyNested 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
EMPTYFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedBaseNodesXContentResponse(ClusterName clusterName, List<TNodeResponse> nodes, List<FailedNodeException> failures) -
Method Summary
Modifier and TypeMethodDescriptionfinal Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params) Create an iterator ofToXContentchunks for a REST response.protected abstract Iterator<? extends ToXContent> xContentChunks(ToXContent.Params outerParams) Methods inherited from class org.elasticsearch.action.support.nodes.BaseNodesResponse
failures, getClusterName, getNodes, getNodesMap, hasFailures, readNodesFrom, writeNodesTo, writeToMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRefMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent
toXContentChunkedV7Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContentObject
isFragmentMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRef
-
Constructor Details
-
BaseNodesXContentResponse
protected BaseNodesXContentResponse(ClusterName clusterName, List<TNodeResponse> nodes, List<FailedNodeException> failures)
-
-
Method Details
-
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
-
xContentChunks
-