org.elasticsearch.action.bulk.byscroll

Class ParentBulkByScrollTask

java.lang.Object

org.elasticsearch.tasks.Task

org.elasticsearch.tasks.CancellableTask

org.elasticsearch.action.bulk.byscroll.BulkByScrollTask

org.elasticsearch.action.bulk.byscroll.ParentBulkByScrollTask

public class ParentBulkByScrollTask
extends BulkByScrollTask

Task for parent bulk by scroll requests that have sub-workers.

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
ParentBulkByScrollTask(long id, java.lang.String type, java.lang.String action, java.lang.String description, TaskId parentTaskId, int slices)

Method Summary

Modifier and Type	Method and Description
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.
void	onSliceResponse(ActionListener<BulkByScrollResponse> listener, int sliceId, BulkByScrollResponse response) Record a response from a slice and respond to the listener if the request is finished.
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, onCancelled

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

Constructor Detail

ParentBulkByScrollTask

public ParentBulkByScrollTask(long id,
                              java.lang.String type,
                              java.lang.String action,
                              java.lang.String description,
                              TaskId parentTaskId,
                              int slices)

Method Detail

rethrottle

public void rethrottle(float newRequestsPerSecond)

Description copied from class: BulkByScrollTask

Apply the newRequestsPerSecond.

Specified by:

rethrottle in class BulkByScrollTask

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

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

onSliceResponse

public void onSliceResponse(ActionListener<BulkByScrollResponse> listener,
                            int sliceId,
                            BulkByScrollResponse response)

Record a response from a slice and respond to the listener if the request is finished.