Package org.elasticsearch.client.indexlifecycle

Class LifecyclePolicy

java.lang.Object

org.elasticsearch.client.indexlifecycle.LifecyclePolicy

All Implemented Interfaces:

ToXContent, ToXContentObject

public class LifecyclePolicy
extends Object
implements ToXContentObject

Represents the lifecycle of an index from creation to deletion. A LifecyclePolicy is made up of a set of Phases which it will move through.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static ConstructingObjectParser<LifecyclePolicy,String>	PARSER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
LifecyclePolicy(String name, Map<String,Phase> phases)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getName()
Map<String,Phase>	getPhases()
int	hashCode()
static LifecyclePolicy	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

Field Detail

PARSER

public static ConstructingObjectParser<LifecyclePolicy,String> PARSER

Constructor Detail

LifecyclePolicy

public LifecyclePolicy(String name,
                       Map<String,Phase> phases)

Parameters:

name - the name of this LifecyclePolicy

phases - a Map of Phases which make up this LifecyclePolicy.

Method Detail

parse

public static LifecyclePolicy parse(XContentParser parser,
                                    String name)

getName

public String getName()

Returns:

the name of this LifecyclePolicy

getPhases

public Map<String,Phase> getPhases()

Returns:

the Phases for this LifecyclePolicy in the order in which they will be executed.

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