Module org.elasticsearch.server

Package org.elasticsearch.action.support.broadcast

Class ChunkedBroadcastResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.support.broadcast.BaseBroadcastResponse

org.elasticsearch.action.support.broadcast.ChunkedBroadcastResponse

All Implemented Interfaces:

Writeable, ChunkedToXContent, ChunkedToXContentObject, RefCounted

Direct Known Subclasses:

FieldUsageStatsResponse, IndicesSegmentResponse, IndicesStatsResponse

public abstract class ChunkedBroadcastResponse
extends BaseBroadcastResponse
implements ChunkedToXContentObject

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 inherited from class org.elasticsearch.action.support.broadcast.BaseBroadcastResponse

EMPTY

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

EMPTY

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
ChunkedBroadcastResponse(int totalShards, int successfulShards, int failedShards, List<DefaultShardOperationFailedException> shardFailures)
ChunkedBroadcastResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected abstract Iterator<ToXContent>	customXContentChunks(ToXContent.Params params)
final Iterator<ToXContent>	toXContentChunked(ToXContent.Params params)	Create an iterator of ToXContent chunks for a REST response.

Methods inherited from class org.elasticsearch.action.support.broadcast.BaseBroadcastResponse

declareBroadcastFields, getFailedShards, getShardFailures, getStatus, getSuccessfulShards, getTotalShards, writeTo

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.ChunkedToXContent

toXContentChunkedV7

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

isFragment

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Constructor Details

ChunkedBroadcastResponse

public ChunkedBroadcastResponse(StreamInput in)
                         throws IOException

Throws:

IOException

ChunkedBroadcastResponse

public ChunkedBroadcastResponse(int totalShards,
 int successfulShards,
 int failedShards,
 List<DefaultShardOperationFailedException> shardFailures)

Method Details

toXContentChunked

public final Iterator<ToXContent> toXContentChunked(ToXContent.Params params)

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

customXContentChunks

protected abstract Iterator<ToXContent> customXContentChunks(ToXContent.Params params)