Module org.elasticsearch.server

Package org.elasticsearch.action.support.broadcast

Class BroadcastResponse

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

All Implemented Interfaces:

Writeable, RefCounted, ToXContent, ToXContentObject

Direct Known Subclasses:

AnalyzeIndexDiskUsageResponse, DataStreamsStatsAction.Response, ReloadAnalyzersResponse, ValidateQueryResponse

public class BroadcastResponse
extends BaseBroadcastResponse
implements ToXContentObject

Nested Class Summary

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

ActionResponse.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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.core.RefCounted

ALWAYS_REFERENCED

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	addCustomXContentFields(XContentBuilder builder, ToXContent.Params params)	Override in subclass to add custom fields following the common `_shards` field
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

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.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

BroadcastResponse

public BroadcastResponse(StreamInput in)
                  throws IOException

Throws:

IOException

BroadcastResponse

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

Method Details

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

addCustomXContentFields

protected void addCustomXContentFields(XContentBuilder builder,
 ToXContent.Params params)
                                throws IOException

Override in subclass to add custom fields following the common `_shards` field

Throws:

IOException