Package org.opensearch.action.admin.indices.segments

Class IndicesSegmentResponse

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportResponse

org.opensearch.action.ActionResponse

org.opensearch.action.support.broadcast.BroadcastResponse

org.opensearch.action.admin.indices.segments.IndicesSegmentResponse

All Implemented Interfaces:

Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject

public class IndicesSegmentResponse
extends BroadcastResponse

Nested Class Summary

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

TransportResponse.Empty

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

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

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

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

EMPTY

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected void	addCustomXContentFields(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)	Override in subclass to add custom fields following the common `_shards` field
java.util.Map<java.lang.String,IndexSegments>	getIndices()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

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

Methods inherited from class org.opensearch.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.opensearch.common.xcontent.ToXContentObject

isFragment

Method Details

getIndices

public java.util.Map<java.lang.String,IndexSegments> getIndices()

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

Overrides:

writeTo in class BroadcastResponse

Throws:

java.io.IOException

addCustomXContentFields

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

Description copied from class: BroadcastResponse

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

Overrides:

addCustomXContentFields in class BroadcastResponse

Throws:

java.io.IOException