Package org.opensearch.action.admin.indices.stats

Class IndicesStatsResponse

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.core.transport.TransportResponse

org.opensearch.core.action.ActionResponse

org.opensearch.action.support.broadcast.BroadcastResponse

org.opensearch.action.admin.indices.stats.IndicesStatsResponse

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject

@PublicApi(since="1.0.0")
public class IndicesStatsResponse
extends BroadcastResponse

Transport response for retrieving indices stats

Opensearch.api:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.core.transport.TransportResponse

org.opensearch.core.transport.TransportResponse.Empty

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.action.support.broadcast.BroadcastResponse

EMPTY

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
IndicesStatsResponse(ShardStats[] shards, int totalShards, int successfulShards, int failedShards, List<org.opensearch.core.action.support.DefaultShardOperationFailedException> shardFailures)

Method Summary

Modifier and Type	Method	Description
protected void	addCustomXContentFields(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)	Override in subclass to add custom fields following the common `_shards` field
Map<ShardRouting,ShardStats>	asMap()
ShardStats	getAt(int position)
IndexStats	getIndex(String index)
Map<String,IndexStats>	getIndices()
CommonStats	getPrimaries()
ShardStats[]	getShards()
CommonStats	getTotal()
String	toString()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.action.support.broadcast.BroadcastResponse

declareBroadcastFields, getFailedShards, getShardFailures, getStatus, getSuccessfulShards, getTotalShards, toXContent

Methods inherited from class org.opensearch.core.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Constructor Details

IndicesStatsResponse

public IndicesStatsResponse(ShardStats[] shards,
 int totalShards,
 int successfulShards,
 int failedShards,
 List<org.opensearch.core.action.support.DefaultShardOperationFailedException> shardFailures)

Method Details

asMap

public Map<ShardRouting,ShardStats> asMap()

getShards

public ShardStats[] getShards()

getAt

public ShardStats getAt(int position)

getIndex

public IndexStats getIndex(String index)

getIndices

public Map<String,IndexStats> getIndices()

getTotal

public CommonStats getTotal()

getPrimaries

public CommonStats getPrimaries()

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class BroadcastResponse

Throws:

IOException

addCustomXContentFields

protected void addCustomXContentFields(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                throws IOException

Description copied from class: BroadcastResponse

Override in subclass to add custom fields following the common `_shards` field

Overrides:

addCustomXContentFields in class BroadcastResponse

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object