Class BroadcastResponse
- java.lang.Object
-
- org.elasticsearch.transport.TransportMessage
-
- org.elasticsearch.transport.TransportResponse
-
- org.elasticsearch.action.ActionResponse
-
- org.elasticsearch.action.support.broadcast.BroadcastResponse
-
- All Implemented Interfaces:
Writeable
,ToXContent
,ToXContentObject
- Direct Known Subclasses:
ClearIndicesCacheResponse
,FlushResponse
,ForceMergeResponse
,IndicesSegmentResponse
,IndicesStatsResponse
,RecoveryResponse
,RefreshResponse
,UpgradeResponse
,UpgradeStatusResponse
,ValidateQueryResponse
public class BroadcastResponse extends ActionResponse implements ToXContentObject
Base class for all broadcast operation based responses.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse
TransportResponse.Empty
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.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 Modifier and Type Field Description static DefaultShardOperationFailedException[]
EMPTY
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description BroadcastResponse()
BroadcastResponse(int totalShards, int successfulShards, int failedShards, java.util.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` fieldprotected static <T extends BroadcastResponse>
voiddeclareBroadcastFields(ConstructingObjectParser<T,java.lang.Void> PARSER)
int
getFailedShards()
The failed shards this request was executed on.DefaultShardOperationFailedException[]
getShardFailures()
The list of shard failures exception.RestStatus
getStatus()
The REST status that should be used for the responseint
getSuccessfulShards()
The successful shards this request was executed on.int
getTotalShards()
The total shards this request ran against.XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.-
Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress
-
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.ToXContentObject
isFragment
-
-
-
-
Field Detail
-
EMPTY
public static final DefaultShardOperationFailedException[] EMPTY
-
-
Constructor Detail
-
BroadcastResponse
public BroadcastResponse()
-
BroadcastResponse
public BroadcastResponse(StreamInput in) throws java.io.IOException
- Throws:
java.io.IOException
-
BroadcastResponse
public BroadcastResponse(int totalShards, int successfulShards, int failedShards, java.util.List<DefaultShardOperationFailedException> shardFailures)
-
-
Method Detail
-
declareBroadcastFields
protected static <T extends BroadcastResponse> void declareBroadcastFields(ConstructingObjectParser<T,java.lang.Void> PARSER)
-
getTotalShards
public int getTotalShards()
The total shards this request ran against.
-
getSuccessfulShards
public int getSuccessfulShards()
The successful shards this request was executed on.
-
getFailedShards
public int getFailedShards()
The failed shards this request was executed on.
-
getStatus
public RestStatus getStatus()
The REST status that should be used for the response
-
getShardFailures
public DefaultShardOperationFailedException[] getShardFailures()
The list of shard failures exception.
-
writeTo
public void writeTo(StreamOutput out) throws java.io.IOException
Description copied from interface:Writeable
Write this into the StreamOutput.
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
addCustomXContentFields
protected void addCustomXContentFields(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
Override in subclass to add custom fields following the common `_shards` field- Throws:
java.io.IOException
-
-