Package org.opensearch.action.admin.indices.close

Class CloseIndexResponse

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.core.transport.TransportResponse

org.opensearch.core.action.ActionResponse

org.opensearch.action.support.master.AcknowledgedResponse

org.opensearch.action.support.master.ShardsAcknowledgedResponse

org.opensearch.action.admin.indices.close.CloseIndexResponse

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 CloseIndexResponse
extends ShardsAcknowledgedResponse

Transport response for closing an index

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CloseIndexResponse.IndexResult	Inner index result
static class	CloseIndexResponse.ShardResult	Shard Result from Close Index Response

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.master.ShardsAcknowledgedResponse

SHARDS_ACKNOWLEDGED

Fields inherited from class org.opensearch.action.support.master.AcknowledgedResponse

acknowledged

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CloseIndexResponse(boolean acknowledged, boolean shardsAcknowledged, List<CloseIndexResponse.IndexResult> indices)

Method Summary

Modifier and Type	Method	Description
protected void	addCustomFields(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
List<CloseIndexResponse.IndexResult>	getIndices()
String	toString()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.action.support.master.ShardsAcknowledgedResponse

declareAcknowledgedAndShardsAcknowledgedFields, equals, hashCode, isShardsAcknowledged, writeShardsAcknowledged

Methods inherited from class org.opensearch.action.support.master.AcknowledgedResponse

declareAcknowledgedField, fromXContent, isAcknowledged, toXContent

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

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

isFragment

Constructor Details

CloseIndexResponse

public CloseIndexResponse(boolean acknowledged,
 boolean shardsAcknowledged,
 List<CloseIndexResponse.IndexResult> indices)

Method Details

getIndices

public List<CloseIndexResponse.IndexResult> getIndices()

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 AcknowledgedResponse

Throws:

IOException

addCustomFields

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

Overrides:

addCustomFields in class ShardsAcknowledgedResponse

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object