Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.utils

Class PhaseProgress

java.lang.Object

org.elasticsearch.xpack.core.ml.utils.PhaseProgress

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class PhaseProgress
extends Object
implements ToXContentObject, Writeable

A class that describes a phase and its progress as a percentage

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ConstructingObjectParser<PhaseProgress,Void>	PARSER
static final ParseField	PHASE
static final ParseField	PROGRESS_PERCENT

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
PhaseProgress(String phase, int progressPercent)
PhaseProgress(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getPhase()
int	getProgressPercent()
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

PHASE

public static final ParseField PHASE

PROGRESS_PERCENT

public static final ParseField PROGRESS_PERCENT

PARSER

public static final ConstructingObjectParser<PhaseProgress,Void> PARSER

Constructor Details

PhaseProgress

public PhaseProgress(String phase,
 int progressPercent)

PhaseProgress

public PhaseProgress(StreamInput in)
              throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getPhase

public String getPhase()

getProgressPercent

public int getProgressPercent()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object