Class LifecyclePolicy
- java.lang.Object
-
- org.elasticsearch.client.indexlifecycle.LifecyclePolicy
-
- All Implemented Interfaces:
ToXContent
,ToXContentObject
public class LifecyclePolicy extends java.lang.Object implements ToXContentObject
Represents the lifecycle of an index from creation to deletion. ALifecyclePolicy
is made up of a set ofPhase
s 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,java.lang.String>
PARSER
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description LifecyclePolicy(java.lang.String name, java.util.Map<java.lang.String,Phase> phases)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.String
getName()
java.util.Map<java.lang.String,Phase>
getPhases()
int
hashCode()
static LifecyclePolicy
parse(XContentParser parser, java.lang.String name)
java.lang.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,java.lang.String> PARSER
-
-
Constructor Detail
-
LifecyclePolicy
public LifecyclePolicy(java.lang.String name, java.util.Map<java.lang.String,Phase> phases)
- Parameters:
name
- the name of thisLifecyclePolicy
phases
- aMap
ofPhase
s which make up thisLifecyclePolicy
.
-
-
Method Detail
-
parse
public static LifecyclePolicy parse(XContentParser parser, java.lang.String name)
-
getName
public java.lang.String getName()
- Returns:
- the name of this
LifecyclePolicy
-
getPhases
public java.util.Map<java.lang.String,Phase> getPhases()
- Returns:
- the
Phase
s for thisLifecyclePolicy
in the order in which they will be executed.
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-