Module org.elasticsearch.server

Package org.elasticsearch.action.datastreams

Class GetDataStreamAction.Response

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.datastreams.GetDataStreamAction.Response

All Implemented Interfaces:

Writeable, RefCounted, ToXContent, ToXContentObject

Enclosing class:

GetDataStreamAction

public static class GetDataStreamAction.Response
extends ActionResponse
implements ToXContentObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetDataStreamAction.Response.DataStreamInfo
static final record	GetDataStreamAction.Response.IndexProperties	Encapsulates the configured properties we want to display for each backing index.
static enum	GetDataStreamAction.Response.ManagedBy
static final record	GetDataStreamAction.Response.TimeSeries

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	DATA_STREAMS_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
Response(List<GetDataStreamAction.Response.DataStreamInfo> dataStreams)
Response(List<GetDataStreamAction.Response.DataStreamInfo> dataStreams, RolloverConfiguration rolloverConfiguration, DataStreamGlobalRetention dataGlobalRetention, DataStreamGlobalRetention failuresGlobalRetention)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
DataStreamGlobalRetention	getDataGlobalRetention()
List<GetDataStreamAction.Response.DataStreamInfo>	getDataStreams()
DataStreamGlobalRetention	getFailuresGlobalRetention()
RolloverConfiguration	getRolloverConfiguration()
int	hashCode()
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, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

DATA_STREAMS_FIELD

public static final ParseField DATA_STREAMS_FIELD

Constructor Details

Response

public Response(List<GetDataStreamAction.Response.DataStreamInfo> dataStreams)

Response

public Response(List<GetDataStreamAction.Response.DataStreamInfo> dataStreams,
 @Nullable
 RolloverConfiguration rolloverConfiguration,
 @Nullable
 DataStreamGlobalRetention dataGlobalRetention,
 @Nullable
 DataStreamGlobalRetention failuresGlobalRetention)

Method Details

getDataStreams

public List<GetDataStreamAction.Response.DataStreamInfo> getDataStreams()

getRolloverConfiguration

@Nullable
public RolloverConfiguration getRolloverConfiguration()

getDataGlobalRetention

@Nullable
public DataStreamGlobalRetention getDataGlobalRetention()

getFailuresGlobalRetention

@Nullable
public DataStreamGlobalRetention getFailuresGlobalRetention()

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object