org.elasticsearch.action.bulk.byscroll

Class BulkByScrollTask

java.lang.Object

org.elasticsearch.tasks.Task

org.elasticsearch.tasks.CancellableTask

org.elasticsearch.action.bulk.byscroll.BulkByScrollTask

Direct Known Subclasses:

ParentBulkByScrollTask, WorkingBulkByScrollTask

public abstract class BulkByScrollTask
extends CancellableTask

Task storing information about a currently running BulkByScroll request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BulkByScrollTask.Status
static class	BulkByScrollTask.StatusOrException The status of a slice of the request.

Constructor Summary

Constructors

Constructor and Description
BulkByScrollTask(long id, java.lang.String type, java.lang.String action, java.lang.String description, TaskId parentTaskId)

Method Summary

Modifier and Type	Method and Description
abstract 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.
abstract BulkByScrollTask.Status	getStatus() Build a status for this task or null if this task doesn't have status.
abstract void	rethrottle(float newRequestsPerSecond) Apply the newRequestsPerSecond.
abstract int	runningSliceSubTasks() The number of sub-slices that are still running.
boolean	shouldCancelChildrenOnCancellation() Returns true if this task should can potentially have children that needs to be cancelled when the parent is cancelled.

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

BulkByScrollTask

public BulkByScrollTask(long id,
                        java.lang.String type,
                        java.lang.String action,
                        java.lang.String description,
                        TaskId parentTaskId)

Method Detail

runningSliceSubTasks

public abstract int runningSliceSubTasks()

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.

rethrottle

public abstract void rethrottle(float newRequestsPerSecond)

Apply the newRequestsPerSecond.

getStatus

public abstract 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.

Overrides:

getStatus in class Task

getInfoGivenSliceInfo

public abstract 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.

shouldCancelChildrenOnCancellation

public boolean shouldCancelChildrenOnCancellation()

Description copied from class: CancellableTask

Returns true if this task should can potentially have children that needs to be cancelled when the parent is cancelled.

Specified by:

shouldCancelChildrenOnCancellation in class CancellableTask