Package org.elasticsearch.action.search

Class SearchTask

java.lang.Object

org.elasticsearch.tasks.Task

org.elasticsearch.tasks.CancellableTask

org.elasticsearch.action.search.SearchTask

public class SearchTask
extends CancellableTask

Task storing information about a currently running search request.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.tasks.Task

Task.Status

Constructor Summary

Constructors

Constructor	Description
SearchTask(long id, java.lang.String type, java.lang.String action, java.lang.String description, TaskId parentTaskId, java.util.Map<java.lang.String,java.lang.String> headers)

Method Summary

Modifier and Type	Method	Description
boolean	shouldCancelChildrenOnCancellation()	Returns true if this task can potentially have children that need to be cancelled when it parent is cancelled.

Methods inherited from class org.elasticsearch.tasks.CancellableTask

cancelOnParentLeaving, getReasonCancelled, isCancelled, onCancelled

Methods inherited from class java.lang.Object

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

Methods inherited from class org.elasticsearch.tasks.Task

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

Constructor Detail

SearchTask

public SearchTask(long id,
                  java.lang.String type,
                  java.lang.String action,
                  java.lang.String description,
                  TaskId parentTaskId,
                  java.util.Map<java.lang.String,java.lang.String> headers)

Method Detail

shouldCancelChildrenOnCancellation

public boolean shouldCancelChildrenOnCancellation()

Description copied from class: CancellableTask

Returns true if this task can potentially have children that need to be cancelled when it parent is cancelled.

Specified by:

shouldCancelChildrenOnCancellation in class CancellableTask