Package org.elasticsearch.client.indexlifecycle

Class ExplainLifecycleResponse

java.lang.Object

org.elasticsearch.client.indexlifecycle.ExplainLifecycleResponse

All Implemented Interfaces:

ToXContent, ToXContentObject

public class ExplainLifecycleResponse
extends java.lang.Object
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 interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ExplainLifecycleResponse(java.util.Map<java.lang.String,IndexLifecycleExplainResponse> indexResponses)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
static ExplainLifecycleResponse	fromXContent(XContentParser parser)
java.util.Map<java.lang.String,IndexLifecycleExplainResponse>	getIndexResponses()
int	hashCode()
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Constructor Details

ExplainLifecycleResponse

public ExplainLifecycleResponse(java.util.Map<java.lang.String,IndexLifecycleExplainResponse> indexResponses)

Method Details

fromXContent

public static ExplainLifecycleResponse fromXContent(XContentParser parser)

getIndexResponses

public java.util.Map<java.lang.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 java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object