org.elasticsearch.action.bulk.byscroll

Class WorkingBulkByScrollTask

java.lang.Object

org.elasticsearch.tasks.Task

org.elasticsearch.tasks.CancellableTask

org.elasticsearch.action.bulk.byscroll.BulkByScrollTask

org.elasticsearch.action.bulk.byscroll.WorkingBulkByScrollTask

All Implemented Interfaces:

SuccessfullyProcessed

public class WorkingBulkByScrollTask
extends BulkByScrollTask
implements SuccessfullyProcessed

BulkByScrollTask subclass for tasks that actually perform the work. Compare to ParentBulkByScrollTask.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.bulk.byscroll.BulkByScrollTask

BulkByScrollTask.Status, BulkByScrollTask.StatusOrException

Constructor Summary

Constructors

Constructor and Description
WorkingBulkByScrollTask(long id, java.lang.String type, java.lang.String action, java.lang.String description, TaskId parentTask, java.lang.Integer sliceId, float requestsPerSecond)

Method Summary

Modifier and Type	Method and Description
void	countSearchRetry()
long	getCreated() Count of documents created.
long	getDeleted() Count of successful delete operations.
TaskInfo	getInfoGivenSliceInfo(java.lang.String localNodeId, java.util.List<TaskInfo> sliceInfo) Build the status for this task given a snapshot of the information of running slices.
BulkByScrollTask.Status	getStatus() Build a status for this task or null if this task doesn't have status.
long	getUpdated() Count of documents updated.
protected void	onCancelled() Called after the task is cancelled so that it can take any actions that it has to take.
void	rethrottle(float newRequestsPerSecond) Apply the newRequestsPerSecond.
int	runningSliceSubTasks() The number of sub-slices that are still running.

Methods inherited from class org.elasticsearch.action.bulk.byscroll.BulkByScrollTask

shouldCancelChildrenOnCancellation

Methods inherited from class org.elasticsearch.tasks.CancellableTask

cancelOnParentLeaving, getReasonCancelled, isCancelled

Methods inherited from class org.elasticsearch.tasks.Task

getAction, getDescription, getId, getParentTaskId, getStartTime, getType, result, result, taskInfo, taskInfo

Methods inherited from class java.lang.Object

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

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

getSuccessfullyProcessed

Constructor Detail

WorkingBulkByScrollTask

public WorkingBulkByScrollTask(long id,
                               java.lang.String type,
                               java.lang.String action,
                               java.lang.String description,
                               TaskId parentTask,
                               java.lang.Integer sliceId,
                               float requestsPerSecond)

Method Detail

getStatus

public BulkByScrollTask.Status getStatus()

Description copied from class: Task

Build a status for this task or null if this task doesn't have status. Since most tasks don't have status this defaults to returning null. While this can never perform IO it might be a costly operation, requiring collating lists of results, etc. So only use it if you need the value.

Specified by:

getStatus in class BulkByScrollTask

onCancelled

protected void onCancelled()

Description copied from class: CancellableTask

Called after the task is cancelled so that it can take any actions that it has to take.

Overrides:

onCancelled in class CancellableTask

runningSliceSubTasks

public int runningSliceSubTasks()

Description copied from class: BulkByScrollTask

The number of sub-slices that are still running. WorkingBulkByScrollTask will always have 0 and ParentBulkByScrollTask will return the number of waiting tasks. Used to decide how to perform rethrottling.

Specified by:

runningSliceSubTasks in class BulkByScrollTask

getInfoGivenSliceInfo

public TaskInfo getInfoGivenSliceInfo(java.lang.String localNodeId,
                                      java.util.List<TaskInfo> sliceInfo)

Description copied from class: BulkByScrollTask

Build the status for this task given a snapshot of the information of running slices.

Specified by:

getInfoGivenSliceInfo in class BulkByScrollTask

getCreated

public long getCreated()

Description copied from interface: SuccessfullyProcessed

Count of documents created.

Specified by:

getCreated in interface SuccessfullyProcessed

getUpdated

public long getUpdated()

Description copied from interface: SuccessfullyProcessed

Count of documents updated.

Specified by:

getUpdated in interface SuccessfullyProcessed

getDeleted

public long getDeleted()

Description copied from interface: SuccessfullyProcessed

Count of successful delete operations.

Specified by:

getDeleted in interface SuccessfullyProcessed

countSearchRetry

public void countSearchRetry()

rethrottle

public void rethrottle(float newRequestsPerSecond)

Description copied from class: BulkByScrollTask

Apply the newRequestsPerSecond.

Specified by:

rethrottle in class BulkByScrollTask