Module org.elasticsearch.server

Package org.elasticsearch.action.datastreams.lifecycle

Class ExplainDataStreamLifecycleAction.Response

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.datastreams.lifecycle.ExplainDataStreamLifecycleAction.Response

All Implemented Interfaces:

Writeable, ChunkedToXContent, ChunkedToXContentObject, RefCounted

Enclosing class:

ExplainDataStreamLifecycleAction

public static class ExplainDataStreamLifecycleAction.Response
extends ActionResponse
implements ChunkedToXContentObject

Class representing the response for the 'explain' of the data stream lifecycle action for one or more indices.

Nested Class Summary

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

ActionResponse.Empty

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.common.xcontent.ChunkedToXContent

EMPTY

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
Response(List<ExplainIndexDataStreamLifecycle> indices, RolloverConfiguration rolloverConfiguration, DataStreamGlobalRetention globalRetention)
Response(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
DataStreamGlobalRetention	getGlobalRetention()
List<ExplainIndexDataStreamLifecycle>	getIndices()
RolloverConfiguration	getRolloverConfiguration()
int	hashCode()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params outerParams)	Create an iterator of ToXContent chunks for a REST response.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

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

toXContentChunkedV7

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

isFragment

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Field Details

INDICES_FIELD

public static final ParseField INDICES_FIELD

Constructor Details

Response

public Response(List<ExplainIndexDataStreamLifecycle> indices,
 @Nullable
 RolloverConfiguration rolloverConfiguration,
 @Nullable
 DataStreamGlobalRetention globalRetention)

Response

public Response(StreamInput in)
         throws IOException

Throws:

IOException

Method Details

getIndices

public List<ExplainIndexDataStreamLifecycle> getIndices()

getRolloverConfiguration

public RolloverConfiguration getRolloverConfiguration()

getGlobalRetention

public DataStreamGlobalRetention getGlobalRetention()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params outerParams)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Specified by:

toXContentChunked in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent