Package org.elasticsearch.client.indexlifecycle

Class PhaseExecutionInfo

java.lang.Object

org.elasticsearch.client.indexlifecycle.PhaseExecutionInfo

All Implemented Interfaces:

ToXContent, ToXContentObject

public class PhaseExecutionInfo
extends java.lang.Object
implements ToXContentObject

This class contains information about the current phase being executed by Index Lifecycle Management on the specific index.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
PhaseExecutionInfo(java.lang.String policyName, Phase phase, long version, long modifiedDate)	This class holds information about the current phase that is being executed

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
long	getModifiedDate()
Phase	getPhase()
java.lang.String	getPolicyName()
long	getVersion()
int	hashCode()
static PhaseExecutionInfo	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

Constructor Detail

PhaseExecutionInfo

public PhaseExecutionInfo(java.lang.String policyName,
                          Phase phase,
                          long version,
                          long modifiedDate)

This class holds information about the current phase that is being executed

Parameters:

policyName - the name of the policy being executed, this may not be the current policy assigned to an index

phase - the current phase definition executed

version - the version of the policyName being executed

modifiedDate - the time the executing version of the phase was modified

Method Detail

parse

public static PhaseExecutionInfo parse(XContentParser parser,
                                       java.lang.String name)

getPolicyName

public java.lang.String getPolicyName()

getPhase

public Phase getPhase()

getVersion

public long getVersion()

getModifiedDate

public long getModifiedDate()

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

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException