Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ilm

Class Phase

java.lang.Object

org.elasticsearch.xpack.core.ilm.Phase

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class Phase
extends Object
implements ToXContentObject, Writeable

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.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	ACTIONS_FIELD
static final ParseField	MIN_AGE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Phase(String name, TimeValue minimumAge, Map<String,LifecycleAction> actions)
Phase(StreamInput in)	For Serialization

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

MIN_AGE

public static final ParseField MIN_AGE

ACTIONS_FIELD

public static final ParseField ACTIONS_FIELD

Constructor Details

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 his Phase. The keys in this map are the associated action names. The order of these actions is defined by the LifecycleType

Phase

public Phase(StreamInput in)
      throws IOException

For Serialization

Throws:

IOException

Method Details

parse

public static Phase parse(XContentParser parser,
 String name)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

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 his 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

maybeAddDeprecationWarningForFreezeAction

public boolean maybeAddDeprecationWarningForFreezeAction(String policyName)