java.lang.Object

org.elasticsearch.client.indexlifecycle.LifecyclePolicy

public class LifecyclePolicy
extends java.lang.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,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)`

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

isFragment

Field Details
- PARSER
  
  public static final ConstructingObjectParser<LifecyclePolicy,java.lang.String> PARSER
Constructor Details
- LifecyclePolicy
  
  public LifecyclePolicy(java.lang.String name, java.util.Map<java.lang.String,Phase> phases)
  
  Parameters:
  
  name - the name of this LifecyclePolicy
  
  phases - a Map of Phases which make up this LifecyclePolicy.
Method Details
- 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 Phases for this LifecyclePolicy 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 interface ToXContent
  
  Throws:
  
  java.io.IOException
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class java.lang.Object
- equals
  
  public boolean equals(java.lang.Object obj)
  
  Overrides:
  
  equals in class java.lang.Object
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object

Class LifecyclePolicy