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.BroadcastResponse
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
Direct Known Subclasses:
ClearIndicesCacheResponse, FlushResponse, ForceMergeResponse, IndicesSegmentResponse, IndicesStatsResponse, RecoveryResponse, RefreshResponse, UpgradeResponse, UpgradeStatusResponse, ValidateQueryResponse
public class BroadcastResponse
extends ActionResponse
implements org.elasticsearch.common.xcontent.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

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
    Override in subclass to add custom fields following the common `_shards` field
    protected static <T extends BroadcastResponse>
    void    		 declareBroadcastFields​(org.elasticsearch.common.xcontent.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 response
    int getSuccessfulShards()
    The successful shards this request was executed on.
    int getTotalShards()
    The total shards this request ran against.
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.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 Details

  • Constructor Details

  • Method Details

    • declareBroadcastFields

      protected static <T extends BroadcastResponse> void declareBroadcastFields​(org.elasticsearch.common.xcontent.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.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • addCustomXContentFields

      protected void addCustomXContentFields​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Override in subclass to add custom fields following the common `_shards` field
      Throws:
      java.io.IOException