Class Phase
java.lang.Object
org.elasticsearch.client.indexlifecycle.Phase
- All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class Phase
extends java.lang.Object
implements org.elasticsearch.common.xcontent.ToXContentObject
Represents set of
LifecycleAction
s which should be executed at a
particular point in the lifecycle of an index.-
Nested Class Summary
-
Field Summary
-
Constructor Summary
Constructors Constructor Description Phase(java.lang.String name, org.elasticsearch.common.unit.TimeValue minimumAge, java.util.Map<java.lang.String,LifecycleAction> actions)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.util.Map<java.lang.String,LifecycleAction>
getActions()
org.elasticsearch.common.unit.TimeValue
getMinimumAge()
java.lang.String
getName()
int
hashCode()
static Phase
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)
-
Constructor Details
-
Phase
public Phase(java.lang.String name, org.elasticsearch.common.unit.TimeValue minimumAge, java.util.Map<java.lang.String,LifecycleAction> actions)- Parameters:
name
- the name of thisPhase
.minimumAge
- the age of the index when the index should move to thisPhase
.actions
- aMap
of theLifecycleAction
s to run when during thisPhase
. The keys in this map are the associated action names.
-
-
Method Details
-
parse
public static Phase parse(org.elasticsearch.common.xcontent.XContentParser parser, java.lang.String name) -
getMinimumAge
public org.elasticsearch.common.unit.TimeValue getMinimumAge()- Returns:
- the age of the index when the index should move to this
Phase
.
-
getName
public java.lang.String getName()- Returns:
- the name of this
Phase
-
getActions
- Returns:
- a
Map
of theLifecycleAction
s to run when during thisPhase
.
-
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
-