Module org.elasticsearch.server

Package org.elasticsearch.action.datastreams.lifecycle

Class ExplainIndexDataStreamLifecycle

java.lang.Object

org.elasticsearch.action.datastreams.lifecycle.ExplainIndexDataStreamLifecycle

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class ExplainIndexDataStreamLifecycle
extends Object
implements Writeable, ToXContentObject

Encapsulates the information that describes an index from its data stream lifecycle perspective.

Nested Class Summary

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 inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ExplainIndexDataStreamLifecycle(String index, boolean managedByLifecycle, Long indexCreationDate, Long rolloverDate, TimeValue generationDate, DataStreamLifecycle lifecycle, String error)
ExplainIndexDataStreamLifecycle(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getError()
TimeValue	getGenerationTime(Supplier<Long> now)	Calculates the time since this index started progressing towards the remaining of its lifecycle past rollover.
String	getIndex()
Long	getIndexCreationDate()
DataStreamLifecycle	getLifecycle()
Long	getRolloverDate()
TimeValue	getTimeSinceIndexCreation(Supplier<Long> now)	Calculates the time lapsed since the index was created.
TimeValue	getTimeSinceRollover(Supplier<Long> now)	Calculates the time lapsed since the index was rolled over.
int	hashCode()
boolean	isManagedByLifecycle()
void	setNowSupplier(Supplier<Long> nowSupplier)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params, RolloverConfiguration rolloverConfiguration)
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.xcontent.ToXContentObject

isFragment

Constructor Details

ExplainIndexDataStreamLifecycle

public ExplainIndexDataStreamLifecycle(String index,
 boolean managedByLifecycle,
 @Nullable
 Long indexCreationDate,
 @Nullable
 Long rolloverDate,
 @Nullable
 TimeValue generationDate,
 @Nullable
 DataStreamLifecycle lifecycle,
 @Nullable
 String error)

ExplainIndexDataStreamLifecycle

public ExplainIndexDataStreamLifecycle(StreamInput in)
                                throws IOException

Throws:

IOException

Method Details

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

Throws:

IOException

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

getGenerationTime

@Nullable
public TimeValue getGenerationTime(Supplier<Long> now)

Calculates the time since this index started progressing towards the remaining of its lifecycle past rollover. Every index will either have to wait to be rolled over before progressing towards its retention part of its lifecycle, or be added to the datastream manually. If the index is the write index this will return null.

getTimeSinceIndexCreation

@Nullable
public TimeValue getTimeSinceIndexCreation(Supplier<Long> now)

Calculates the time lapsed since the index was created. It can be null as we don't serialise the index creation field for un-managed indices.

getTimeSinceRollover

@Nullable
public TimeValue getTimeSinceRollover(Supplier<Long> now)

Calculates the time lapsed since the index was rolled over. It can be null if the index was not rolled over or for un-managed indecs as we don't serialise the rollover data field.

getIndex

public String getIndex()

isManagedByLifecycle

public boolean isManagedByLifecycle()

getIndexCreationDate

public Long getIndexCreationDate()

getRolloverDate

public Long getRolloverDate()

getLifecycle

public DataStreamLifecycle getLifecycle()

getError

public String getError()

setNowSupplier

public void setNowSupplier(Supplier<Long> nowSupplier)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object