public static class BulkByScrollTask.Status extends java.lang.Object implements Task.Status, SuccessfullyProcessed
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Writeable.Reader<V>, Writeable.Writer<V>
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 |
EMPTY_PARAMS
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) |
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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
isFragment
getSuccessfullyProcessed
public static final java.lang.String NAME
public static final java.lang.String INCLUDE_CREATED
public static final java.lang.String INCLUDE_UPDATED
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)
public Status(java.util.List<BulkByScrollTask.StatusOrException> sliceStatuses, @Nullable java.lang.String reasonCancelled)
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.public Status(StreamInput in) throws java.io.IOException
java.io.IOException
public void writeTo(StreamOutput out) throws java.io.IOException
Writeable
public java.lang.String getWriteableName()
NamedWriteable
getWriteableName
in interface NamedWriteable
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
toXContent
in interface ToXContent
java.io.IOException
public XContentBuilder innerXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
java.io.IOException
public java.lang.String toString()
toString
in class java.lang.Object
public void innerToString(java.lang.StringBuilder builder)
public long getTotal()
public long getUpdated()
SuccessfullyProcessed
getUpdated
in interface SuccessfullyProcessed
public long getCreated()
SuccessfullyProcessed
getCreated
in interface SuccessfullyProcessed
public long getDeleted()
SuccessfullyProcessed
getDeleted
in interface SuccessfullyProcessed
public int getBatches()
public long getVersionConflicts()
public long getNoops()
public long getBulkRetries()
public long getSearchRetries()
public TimeValue getThrottled()
public float getRequestsPerSecond()
public java.lang.String getReasonCancelled()
public TimeValue getThrottledUntil()
public java.util.List<BulkByScrollTask.StatusOrException> getSliceStatuses()