Package org.opensearch.client.core

Class BroadcastResponse

java.lang.Object

org.opensearch.client.core.BroadcastResponse

Direct Known Subclasses:

DataStreamsStatsResponse

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

Constructors

Modifier	Constructor	Description
protected	BroadcastResponse(BroadcastResponse.Shards shards)

Method Summary

Modifier and Type	Method	Description
protected static <T extends BroadcastResponse> void	declareShardsField(org.opensearch.common.xcontent.ConstructingObjectParser<T,java.lang.Void> PARSER)
static BroadcastResponse	fromXContent(org.opensearch.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 Detail

BroadcastResponse

protected BroadcastResponse(BroadcastResponse.Shards shards)

Method Detail

shards

public BroadcastResponse.Shards shards()

Represents the shard-level summary of the response execution.

Returns:

the shard-level response summary

fromXContent

public static BroadcastResponse fromXContent(org.opensearch.common.xcontent.XContentParser parser)
                                      throws java.io.IOException

Parses a broadcast response.

Parameters:

parser - the parser

Returns:

a broadcast response parsed from the specified parser

Throws:

java.io.IOException - if an I/O exception occurs parsing the response

declareShardsField

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