Module org.elasticsearch.server

Package org.elasticsearch.action.datastreams.lifecycle

Class GetDataStreamLifecycleAction.Response

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.datastreams.lifecycle.GetDataStreamLifecycleAction.Response

All Implemented Interfaces:

Writeable, ChunkedToXContent, ChunkedToXContentObject, RefCounted

Enclosing class:

GetDataStreamLifecycleAction

public static class GetDataStreamLifecycleAction.Response
extends ActionResponse
implements ChunkedToXContentObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	GetDataStreamLifecycleAction.Response.DataStreamLifecycle

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	DATA_STREAMS_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<GetDataStreamLifecycleAction.Response.DataStreamLifecycle> dataStreamLifecycles)
Response(List<GetDataStreamLifecycleAction.Response.DataStreamLifecycle> dataStreamLifecycles, RolloverConfiguration rolloverConfiguration, DataStreamGlobalRetention globalRetention)
Response(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<GetDataStreamLifecycleAction.Response.DataStreamLifecycle>	getDataStreamLifecycles()
DataStreamGlobalRetention	getGlobalRetention()
RolloverConfiguration	getRolloverConfiguration()
int	hashCode()
Iterator<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

DATA_STREAMS_FIELD

public static final ParseField DATA_STREAMS_FIELD

Constructor Details

Response

public Response(List<GetDataStreamLifecycleAction.Response.DataStreamLifecycle> dataStreamLifecycles)

Response

public Response(List<GetDataStreamLifecycleAction.Response.DataStreamLifecycle> dataStreamLifecycles,
 @Nullable
 RolloverConfiguration rolloverConfiguration,
 @Nullable
 DataStreamGlobalRetention globalRetention)

Response

public Response(StreamInput in)
         throws IOException

Throws:

IOException

Method Details

getDataStreamLifecycles

public List<GetDataStreamLifecycleAction.Response.DataStreamLifecycle> getDataStreamLifecycles()

getRolloverConfiguration

@Nullable
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

toXContentChunked

public Iterator<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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object