Module org.elasticsearch.server

Package org.elasticsearch.action.search

Class SearchShardTask

java.lang.Object

org.elasticsearch.tasks.Task

org.elasticsearch.tasks.CancellableTask

org.elasticsearch.action.search.SearchShardTask

All Implemented Interfaces:

Traceable

public class SearchShardTask
extends CancellableTask

Task storing information about a currently running search shard request. See ShardSearchRequest, ShardFetchSearchRequest, ...

Nested Class Summary

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

CancellableTask.CancellationListener

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

Task.Status

Field Summary

Fields inherited from class org.elasticsearch.tasks.Task

APM_TRACE_CONTEXT, HEADERS_TO_COPY, TRACE_ID, TRACE_PARENT, TRACE_PARENT_HTTP_HEADER, TRACE_START_TIME, TRACE_STATE, X_ELASTIC_PRODUCT_ORIGIN_HTTP_HEADER, X_OPAQUE_ID_HTTP_HEADER

Constructor Summary

Constructors

Constructor	Description
SearchShardTask(long id, String type, String action, String description, TaskId parentTaskId, Map<String,String> headers)

Method Summary

Modifier and Type	Method	Description
boolean	shouldCancelChildrenOnCancellation()	Returns whether this task's children need to be cancelled too.

Methods inherited from class org.elasticsearch.tasks.CancellableTask

addListener, ensureNotCancelled, getReasonCancelled, isCancelled, notifyIfCancelled, onCancelled

Methods inherited from class org.elasticsearch.tasks.Task

getAction, getDescription, getHeader, getId, getParentTaskId, getSpanId, getStartTime, getStartTimeNanos, getStatus, getType, headers, result, result, taskInfo, taskInfo, toString

Methods inherited from class java.lang.Object

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

Constructor Details

SearchShardTask

public SearchShardTask(long id,
 String type,
 String action,
 String description,
 TaskId parentTaskId,
 Map<String,String> headers)

Method Details

shouldCancelChildrenOnCancellation

public boolean shouldCancelChildrenOnCancellation()

Description copied from class: CancellableTask

Returns whether this task's children need to be cancelled too. true is a reasonable response even for tasks that have no children, since child tasks might be added in future and it'd be easy to forget to update this, but returning false saves a bit of computation in the task manager.

Overrides:

shouldCancelChildrenOnCancellation in class CancellableTask