Package org.elasticsearch.index.reindex

Class BulkByScrollTask.Status

    • Field Detail

      • 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

      • 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.

      • 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.