Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ilm

Class ExplainLifecycleResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.xpack.core.ilm.ExplainLifecycleResponse

All Implemented Interfaces:

Writeable, RefCounted, ToXContent, ToXContentObject

public class ExplainLifecycleResponse
extends ActionResponse
implements ToXContentObject

The response object returned by the Explain Lifecycle API.

Since the API can be run over multiple indices the response provides a map of index to the explanation of the lifecycle status for that index.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	INDICES_FIELD

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ExplainLifecycleResponse(Map<String,IndexLifecycleExplainResponse> indexResponses)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Map<String,IndexLifecycleExplainResponse>	getIndexResponses()
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	NB prior to 9.0 this was a TransportMasterNodeReadAction so for BwC we must remain able to write these responses until we no longer need to support calling this action remotely.

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

INDICES_FIELD

public static final ParseField INDICES_FIELD

Constructor Details

ExplainLifecycleResponse

public ExplainLifecycleResponse(Map<String,IndexLifecycleExplainResponse> indexResponses)

Method Details

getIndexResponses

public Map<String,IndexLifecycleExplainResponse> getIndexResponses()

Returns:

a map of the responses from each requested index. The maps key is the index name and the value is the IndexLifecycleExplainResponse describing the current lifecycle status of that index

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

NB prior to 9.0 this was a TransportMasterNodeReadAction so for BwC we must remain able to write these responses until we no longer need to support calling this action remotely.

Specified by:

writeTo in interface Writeable

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object