Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.transform.transforms

Class TransformProgress

java.lang.Object

org.elasticsearch.xpack.core.transform.transforms.TransformProgress

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class TransformProgress
extends Object
implements Writeable, ToXContentObject

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 ParseField	DOCS_INDEXED
static final ParseField	DOCS_PROCESSED
static final ParseField	DOCS_REMAINING
static final ConstructingObjectParser<TransformProgress,Void>	PARSER
static final String	PERCENT_COMPLETE
static final ParseField	TOTAL_DOCS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TransformProgress()
TransformProgress(Long totalDocs, Long documentsProcessed, Long documentsIndexed)
TransformProgress(Long totalDocs, Long docsRemaining, Long documentsProcessed, Long documentsIndexed)
TransformProgress(StreamInput in)
TransformProgress(TransformProgress otherProgress)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
long	getDocumentsIndexed()
long	getDocumentsProcessed()
Double	getPercentComplete()
Long	getTotalDocs()
int	hashCode()
void	incrementDocsIndexed(long numDocumentsIndexed)
void	incrementDocsProcessed(long docsProcessed)
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

TOTAL_DOCS

public static final ParseField TOTAL_DOCS

DOCS_REMAINING

public static final ParseField DOCS_REMAINING

DOCS_PROCESSED

public static final ParseField DOCS_PROCESSED

DOCS_INDEXED

public static final ParseField DOCS_INDEXED

PERCENT_COMPLETE

public static final String PERCENT_COMPLETE

See Also:

• Constant Field Values

PARSER

public static final ConstructingObjectParser<TransformProgress,Void> PARSER

Constructor Details

TransformProgress

public TransformProgress()

TransformProgress

public TransformProgress(Long totalDocs,
 Long docsRemaining,
 Long documentsProcessed,
 Long documentsIndexed)

TransformProgress

public TransformProgress(Long totalDocs,
 Long documentsProcessed,
 Long documentsIndexed)

TransformProgress

public TransformProgress(TransformProgress otherProgress)

TransformProgress

public TransformProgress(StreamInput in)
                  throws IOException

Throws:

IOException

Method Details

getPercentComplete

public Double getPercentComplete()

getTotalDocs

public Long getTotalDocs()

incrementDocsProcessed

public void incrementDocsProcessed(long docsProcessed)

incrementDocsIndexed

public void incrementDocsIndexed(long numDocumentsIndexed)

getDocumentsProcessed

public long getDocumentsProcessed()

getDocumentsIndexed

public long getDocumentsIndexed()

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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

toString

public String toString()

Overrides:

toString in class Object