Package org.elasticsearch.client.indexlifecycle

Class Phase

java.lang.Object

org.elasticsearch.client.indexlifecycle.Phase

All Implemented Interfaces:

ToXContent, ToXContentObject

public class Phase
extends Object
implements ToXContentObject

Represents set of LifecycleActions which should be executed at a particular point in the lifecycle of an index.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Phase(String name, TimeValue minimumAge, Map<String,LifecycleAction> actions)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Map<String,LifecycleAction>	getActions()
TimeValue	getMinimumAge()
String	getName()
int	hashCode()
static Phase	parse(XContentParser parser, String name)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

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

isFragment

Constructor Detail

Phase

public Phase(String name,
             TimeValue minimumAge,
             Map<String,LifecycleAction> actions)

Parameters:

name - the name of this Phase.

minimumAge - the age of the index when the index should move to this Phase.

actions - a Map of the LifecycleActions to run when during this Phase. The keys in this map are the associated action names.

Method Detail

parse

public static Phase parse(XContentParser parser,
                          String name)

getMinimumAge

public TimeValue getMinimumAge()

Returns:

the age of the index when the index should move to this Phase.

getName

public String getName()

Returns:

the name of this Phase

getActions

public Map<String,LifecycleAction> getActions()

Returns:

a Map of the LifecycleActions to run when during this Phase.

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object