Module org.elasticsearch.server
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
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse
ActionResponse.EmptyNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested 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
EMPTYFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCEDFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionBroadcastResponse(int totalShards, int successfulShards, int failedShards, List<DefaultShardOperationFailedException> shardFailures) -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddCustomXContentFields(XContentBuilder builder, ToXContent.Params params) Override in subclass to add custom fields following the common `_shards` fieldtoXContent(XContentBuilder builder, ToXContent.Params params) Methods inherited from class org.elasticsearch.action.support.broadcast.BaseBroadcastResponse
getFailedShards, getShardFailures, getStatus, getSuccessfulShards, getTotalShards, 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.core.RefCounted
mustIncRefMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
BroadcastResponse
- 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:
toXContentin interfaceToXContent- 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
-