Module org.elasticsearch.server

Package org.elasticsearch.action.datastreams

Class GetDataStreamAction.Response.DataStreamInfo

java.lang.Object

org.elasticsearch.action.datastreams.GetDataStreamAction.Response.DataStreamInfo

All Implemented Interfaces:

Diffable<GetDataStreamAction.Response.DataStreamInfo>, SimpleDiffable<GetDataStreamAction.Response.DataStreamInfo>, Writeable, ToXContent, ToXContentObject

Enclosing class:

GetDataStreamAction.Response

public static class GetDataStreamAction.Response.DataStreamInfo
extends Object
implements SimpleDiffable<GetDataStreamAction.Response.DataStreamInfo>, ToXContentObject

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.cluster.SimpleDiffable

SimpleDiffable.CompleteDiff<T extends Diffable<T>>

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	ALLOW_CUSTOM_ROUTING
static final ParseField	HIDDEN_FIELD
static final ParseField	ILM_POLICY_FIELD
static final ParseField	INDEX_TEMPLATE_FIELD
static final ParseField	LIFECYCLE_FIELD
static final ParseField	MANAGED_BY
static final ParseField	NEXT_GENERATION_INDEX_MANAGED_BY
static final ParseField	PREFER_ILM
static final ParseField	REPLICATED
static final ParseField	ROLLOVER_ON_WRITE
static final ParseField	STATUS_FIELD
static final ParseField	SYSTEM_FIELD
static final ParseField	TEMPORAL_RANGE_END
static final ParseField	TEMPORAL_RANGE_START
static final ParseField	TEMPORAL_RANGES
static final ParseField	TIME_SERIES

Fields inherited from interface org.elasticsearch.cluster.SimpleDiffable

EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DataStreamInfo(DataStream dataStream, ClusterHealthStatus dataStreamStatus, String indexTemplate, String ilmPolicyName, GetDataStreamAction.Response.TimeSeries timeSeries, Map<Index,GetDataStreamAction.Response.IndexProperties> indexSettingsValues, boolean templatePreferIlmValue)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
DataStream	getDataStream()
ClusterHealthStatus	getDataStreamStatus()
String	getIlmPolicy()
Map<Index,GetDataStreamAction.Response.IndexProperties>	getIndexSettingsValues()
String	getIndexTemplate()
GetDataStreamAction.Response.ManagedBy	getNextGenerationManagedBy()	Computes and returns which system will manage the next generation for this data stream.
GetDataStreamAction.Response.TimeSeries	getTimeSeries()
int	hashCode()
boolean	templatePreferIlmValue()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params, RolloverConfiguration rolloverConfiguration)	Converts the response to XContent and passes the RolloverConditions, when provided, to the data stream.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.SimpleDiffable

diff

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

STATUS_FIELD

public static final ParseField STATUS_FIELD

INDEX_TEMPLATE_FIELD

public static final ParseField INDEX_TEMPLATE_FIELD

PREFER_ILM

public static final ParseField PREFER_ILM

MANAGED_BY

public static final ParseField MANAGED_BY

NEXT_GENERATION_INDEX_MANAGED_BY

public static final ParseField NEXT_GENERATION_INDEX_MANAGED_BY

ILM_POLICY_FIELD

public static final ParseField ILM_POLICY_FIELD

LIFECYCLE_FIELD

public static final ParseField LIFECYCLE_FIELD

HIDDEN_FIELD

public static final ParseField HIDDEN_FIELD

SYSTEM_FIELD

public static final ParseField SYSTEM_FIELD

ALLOW_CUSTOM_ROUTING

public static final ParseField ALLOW_CUSTOM_ROUTING

REPLICATED

public static final ParseField REPLICATED

ROLLOVER_ON_WRITE

public static final ParseField ROLLOVER_ON_WRITE

TIME_SERIES

public static final ParseField TIME_SERIES

TEMPORAL_RANGES

public static final ParseField TEMPORAL_RANGES

TEMPORAL_RANGE_START

public static final ParseField TEMPORAL_RANGE_START

TEMPORAL_RANGE_END

public static final ParseField TEMPORAL_RANGE_END

Constructor Details

DataStreamInfo

public DataStreamInfo(DataStream dataStream,
 ClusterHealthStatus dataStreamStatus,
 @Nullable
 String indexTemplate,
 @Nullable
 String ilmPolicyName,
 @Nullable
 GetDataStreamAction.Response.TimeSeries timeSeries,
 Map<Index,GetDataStreamAction.Response.IndexProperties> indexSettingsValues,
 boolean templatePreferIlmValue)

Method Details

getDataStream

public DataStream getDataStream()

getDataStreamStatus

public ClusterHealthStatus getDataStreamStatus()

getIndexTemplate

@Nullable
public String getIndexTemplate()

getIlmPolicy

@Nullable
public String getIlmPolicy()

getTimeSeries

@Nullable
public GetDataStreamAction.Response.TimeSeries getTimeSeries()

getIndexSettingsValues

public Map<Index,GetDataStreamAction.Response.IndexProperties> getIndexSettingsValues()

templatePreferIlmValue

public boolean templatePreferIlmValue()

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params,
 @Nullable
 RolloverConfiguration rolloverConfiguration)
                           throws IOException

Converts the response to XContent and passes the RolloverConditions, when provided, to the data stream.

Throws:

IOException

getNextGenerationManagedBy

public GetDataStreamAction.Response.ManagedBy getNextGenerationManagedBy()

Computes and returns which system will manage the next generation for this data stream.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object