Class BroadcastResponse

Direct Known Subclasses:
DataStreamsStatsResponse, ReloadAnalyzersResponse

public class BroadcastResponse
extends java.lang.Object
Represents a response to a request that is broadcast to a collection of shards.
  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  BroadcastResponse.Shards
    Represents the results of a collection of shards on which a request was executed against.
  • Constructor Summary

    Modifier Constructor Description
    protected BroadcastResponse​(BroadcastResponse.Shards shards)  
  • Method Summary

    Modifier and Type Method Description
    protected static <T extends BroadcastResponse>
    declareShardsField​(org.elasticsearch.common.xcontent.ConstructingObjectParser<T,​java.lang.Void> PARSER)  
    static BroadcastResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
    Parses a broadcast response.
    BroadcastResponse.Shards shards()
    Represents the shard-level summary of the response execution.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

  • Method Details

    • shards

      public BroadcastResponse.Shards shards()
      Represents the shard-level summary of the response execution.
      the shard-level response summary
    • fromXContent

      public static BroadcastResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws
      Parses a broadcast response.
      parser - the parser
      a broadcast response parsed from the specified parser
      Throws: - if an I/O exception occurs parsing the response
    • declareShardsField

      protected static <T extends BroadcastResponse> void declareShardsField​(org.elasticsearch.common.xcontent.ConstructingObjectParser<T,​java.lang.Void> PARSER)