org.elasticsearch.index.reindex

Class BulkByScrollTask.Status

java.lang.Object

org.elasticsearch.index.reindex.BulkByScrollTask.Status

All Implemented Interfaces:

NamedWriteable<Task.Status>, StreamableReader<Task.Status>, Writeable<Task.Status>, ToXContent, Task.Status

Enclosing class:

BulkByScrollTask

public static class BulkByScrollTask.Status
extends Object
implements Task.Status

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 and Description
static String	NAME
static BulkByScrollTask.Status	PROTOTYPE

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
BulkByScrollTask.Status(long total, long updated, long created, long deleted, int batches, long versionConflicts, long noops, long retries, TimeValue throttled, float requestsPerSecond, String reasonCancelled, TimeValue throttledUntil)
BulkByScrollTask.Status(StreamInput in)

Method Summary

Methods

Modifier and Type	Method and Description
int	getBatches() Number of scan responses this request has processed.
long	getCreated() Count of documents created.
long	getDeleted() Count of successful delete operations.
long	getNoops() Number of noops (skipped bulk items) as part of this request.
String	getReasonCancelled() The reason that the request was canceled or null if it hasn't been.
float	getRequestsPerSecond() The number of requests per second to which to throttle the request.
long	getRetries() Number of retries that had to be attempted due to rejected executions.
TimeValue	getThrottled() The total time this request has throttled itself not including the current throttle time if it is currently sleeping.
TimeValue	getThrottledUntil() Remaining delay of any current throttle sleep or 0 if not sleeping.
long	getTotal() The total number of documents this request will process.
long	getUpdated() Count of documents updated.
long	getVersionConflicts() Number of version conflicts this request has hit.
String	getWriteableName()
void	innerToString(StringBuilder builder, boolean includeCreated, boolean includeDeleted)
XContentBuilder	innerXContent(XContentBuilder builder, ToXContent.Params params, boolean includeCreated, boolean includeDeleted)
BulkByScrollTask.Status	readFrom(StreamInput in)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROTOTYPE

public static final BulkByScrollTask.Status PROTOTYPE

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

BulkByScrollTask.Status

public BulkByScrollTask.Status(long total,
                       long updated,
                       long created,
                       long deleted,
                       int batches,
                       long versionConflicts,
                       long noops,
                       long retries,
                       TimeValue throttled,
                       float requestsPerSecond,
                       @Nullable
                       String reasonCancelled,
                       TimeValue throttledUntil)

BulkByScrollTask.Status

public BulkByScrollTask.Status(StreamInput in)
                        throws IOException

Throws:

IOException

Method Detail

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable<Task.Status>

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

innerXContent

public XContentBuilder innerXContent(XContentBuilder builder,
                            ToXContent.Params params,
                            boolean includeCreated,
                            boolean includeDeleted)
                              throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

innerToString

public void innerToString(StringBuilder builder,
                 boolean includeCreated,
                 boolean includeDeleted)

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable<Task.Status>

readFrom

public BulkByScrollTask.Status readFrom(StreamInput in)
                                 throws IOException

Specified by:

readFrom in interface StreamableReader<Task.Status>

Throws:

IOException

getTotal

public long getTotal()

The total number of documents this request will process. 0 means we don't yet know or, possibly, there are actually 0 documents to process. Its ok that these have the same meaning because any request with 0 actual documents should be quite short lived.

getUpdated

public long getUpdated()

Count of documents updated.

getCreated

public long getCreated()

Count of documents created.

getDeleted

public long getDeleted()

Count of successful delete operations.

getBatches

public int getBatches()

Number of scan responses this request has processed.

getVersionConflicts

public long getVersionConflicts()

Number of version conflicts this request has hit.

getNoops

public long getNoops()

Number of noops (skipped bulk items) as part of this request.

getRetries

public long getRetries()

Number of retries that had to be attempted due to rejected executions.

getThrottled

public TimeValue getThrottled()

The total time this request has throttled itself not including the current throttle time if it is currently sleeping.

getRequestsPerSecond

public float getRequestsPerSecond()

The number of requests per second to which to throttle the request. 0 means unlimited.

getReasonCancelled

public String getReasonCancelled()

The reason that the request was canceled or null if it hasn't been.

getThrottledUntil

public TimeValue getThrottledUntil()

Remaining delay of any current throttle sleep or 0 if not sleeping.