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,org.elasticsearch.core.RefCounted,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject
public class ExplainLifecycleResponse
extends ActionResponse
implements org.elasticsearch.xcontent.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.EmptyNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseFieldFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCEDFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionExplainLifecycleResponse(Map<String, IndexLifecycleExplainResponse> indexResponses) -
Method Summary
Modifier and TypeMethodDescriptionbooleaninthashCode()toString()org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) voidwriteTo(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, tryIncRefMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRefMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
INDICES_FIELD
public static final org.elasticsearch.xcontent.ParseField INDICES_FIELD
-
-
Constructor Details
-
ExplainLifecycleResponse
-
-
Method Details
-
getIndexResponses
- Returns:
- a map of the responses from each requested index. The maps key is
the index name and the value is the
IndexLifecycleExplainResponsedescribing the current lifecycle status of that index
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-
writeTo
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:
writeToin interfaceWriteable- Throws:
IOException
-
hashCode
public int hashCode() -
equals
-
toString
-