org.elasticsearch.action.bulk.byscroll

Class BulkByScrollTask.Status

java.lang.Object

org.elasticsearch.action.bulk.byscroll.BulkByScrollTask.Status

All Implemented Interfaces:

SuccessfullyProcessed, NamedWriteable, Writeable, ToXContent, Task.Status

Enclosing class:

BulkByScrollTask

public static class BulkByScrollTask.Status
extends java.lang.Object
implements Task.Status, SuccessfullyProcessed

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.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 and Description
static java.lang.String	INCLUDE_CREATED XContent param name to indicate if "created" count must be included in the response.
static java.lang.String	INCLUDE_UPDATED XContent param name to indicate if "updated" count must be included in the response.
static java.lang.String	NAME

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Status(java.lang.Integer sliceId, long total, long updated, long created, long deleted, int batches, long versionConflicts, long noops, long bulkRetries, long searchRetries, TimeValue throttled, float requestsPerSecond, java.lang.String reasonCancelled, TimeValue throttledUntil)
Status(java.util.List<BulkByScrollTask.StatusOrException> sliceStatuses, java.lang.String reasonCancelled) Constructor merging many statuses.
Status(StreamInput in)

Method Summary

Modifier and Type	Method and Description
int	getBatches() Number of scan responses this request has processed.
long	getBulkRetries() Number of retries that had to be attempted due to bulk actions being rejected.
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.
java.lang.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	getSearchRetries() Number of retries that had to be attempted due to search actions being rejected.
java.util.List<BulkByScrollTask.StatusOrException>	getSliceStatuses() Statuses of the sub requests into which this sub-request was sliced.
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.
java.lang.String	getWriteableName() Returns the name of the writeable object
void	innerToString(java.lang.StringBuilder builder)
XContentBuilder	innerXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out) Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

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

isFragment

Methods inherited from interface org.elasticsearch.action.bulk.byscroll.SuccessfullyProcessed

getSuccessfullyProcessed

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

INCLUDE_CREATED

public static final java.lang.String INCLUDE_CREATED

XContent param name to indicate if "created" count must be included in the response.

See Also:

Constant Field Values

INCLUDE_UPDATED

public static final java.lang.String INCLUDE_UPDATED

XContent param name to indicate if "updated" count must be included in the response.

See Also:

Constant Field Values

Constructor Detail

Status

public Status(java.lang.Integer sliceId,
              long total,
              long updated,
              long created,
              long deleted,
              int batches,
              long versionConflicts,
              long noops,
              long bulkRetries,
              long searchRetries,
              TimeValue throttled,
              float requestsPerSecond,
              @Nullable
              java.lang.String reasonCancelled,
              TimeValue throttledUntil)

Status

public Status(java.util.List<BulkByScrollTask.StatusOrException> sliceStatuses,
              @Nullable
              java.lang.String reasonCancelled)

Constructor merging many statuses.

Parameters:

sliceStatuses - Statuses of sub requests that this task was sliced into.

reasonCancelled - Reason that this *this* task was cancelled. Note that each entry in sliceStatuses can be cancelled independently of this task but if this task is cancelled then the workers *should* be cancelled.

Status

public Status(StreamInput in)
       throws java.io.IOException

Throws:

java.io.IOException

Method Detail

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

innerXContent

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

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

innerToString

public void innerToString(java.lang.StringBuilder builder)

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()

Description copied from interface: SuccessfullyProcessed

Count of documents updated.

Specified by:

getUpdated in interface SuccessfullyProcessed

getCreated

public long getCreated()

Description copied from interface: SuccessfullyProcessed

Count of documents created.

Specified by:

getCreated in interface SuccessfullyProcessed

getDeleted

public long getDeleted()

Description copied from interface: SuccessfullyProcessed

Count of successful delete operations.

Specified by:

getDeleted in interface SuccessfullyProcessed

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.

getBulkRetries

public long getBulkRetries()

Number of retries that had to be attempted due to bulk actions being rejected.

getSearchRetries

public long getSearchRetries()

Number of retries that had to be attempted due to search actions being rejected.

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. Float.POSITIVE_INFINITY means unlimited.

getReasonCancelled

public java.lang.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.

getSliceStatuses

public java.util.List<BulkByScrollTask.StatusOrException> getSliceStatuses()

Statuses of the sub requests into which this sub-request was sliced. Empty if this request wasn't sliced into sub-requests.