Class LifecyclePolicy
java.lang.Object
org.elasticsearch.client.indexlifecycle.LifecyclePolicy
- All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class LifecyclePolicy
extends java.lang.Object
implements org.elasticsearch.common.xcontent.ToXContentObject
Represents the lifecycle of an index from creation to deletion. A
LifecyclePolicy
is made up of a set of Phase
s which it will
move through.-
Nested Class Summary
-
Field Summary
Fields Modifier and Type Field Description static org.elasticsearch.common.xcontent.ConstructingObjectParser<LifecyclePolicy,java.lang.String>
PARSER
-
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(org.elasticsearch.common.xcontent.XContentParser parser, java.lang.String name)
java.lang.String
toString()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
-
Field Details
-
PARSER
public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<LifecyclePolicy,java.lang.String> PARSER
-
-
Constructor Details
-
LifecyclePolicy
- Parameters:
name
- the name of thisLifecyclePolicy
phases
- aMap
ofPhase
s which make up thisLifecyclePolicy
.
-
-
Method Details
-
parse
public static LifecyclePolicy parse(org.elasticsearch.common.xcontent.XContentParser parser, java.lang.String name) -
getName
public java.lang.String getName()- Returns:
- the name of this
LifecyclePolicy
-
getPhases
- Returns:
- the
Phase
s for thisLifecyclePolicy
in the order in which they will be executed.
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- 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
-