Module org.elasticsearch.server

Package org.elasticsearch.action.search

Class SearchTask

java.lang.Object

org.elasticsearch.tasks.Task

org.elasticsearch.tasks.CancellableTask

org.elasticsearch.action.search.SearchTask

All Implemented Interfaces:

Traceable

public class SearchTask
extends CancellableTask

Task storing information about a currently running SearchRequest.

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
SearchTask(long id, String type, String action, Supplier<String> descriptionSupplier, TaskId parentTaskId, Map<String,String> headers)

Method Summary

Modifier and Type	Method	Description
final String	getDescription()	Generates task description
final SearchProgressListener	getProgressListener()	Return the SearchProgressListener attached to this task.
Supplier<SearchResponseMerger>	getSearchResponseMergerSupplier()
final void	setProgressListener(SearchProgressListener progressListener)	Attach a SearchProgressListener to this task.
void	setSearchResponseMergerSupplier(Supplier<SearchResponseMerger> supplier)

Methods inherited from class org.elasticsearch.tasks.CancellableTask

addListener, ensureNotCancelled, getReasonCancelled, isCancelled, notifyIfCancelled, onCancelled, shouldCancelChildrenOnCancellation

Methods inherited from class org.elasticsearch.tasks.Task

getAction, 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

SearchTask

public SearchTask(long id,
 String type,
 String action,
 Supplier<String> descriptionSupplier,
 TaskId parentTaskId,
 Map<String,String> headers)

Method Details

getDescription

public final String getDescription()

Description copied from class: Task

Generates task description

Overrides:

getDescription in class Task

setProgressListener

public final void setProgressListener(SearchProgressListener progressListener)

Attach a SearchProgressListener to this task.

getProgressListener

public final SearchProgressListener getProgressListener()

Return the SearchProgressListener attached to this task.

getSearchResponseMergerSupplier

public Supplier<SearchResponseMerger> getSearchResponseMergerSupplier()

Returns:

the Supplier of SearchResponseMerger attached to this task. Will be null for local-only search and cross-cluster searches with minimize_roundtrips=false.

setSearchResponseMergerSupplier

public void setSearchResponseMergerSupplier(Supplier<SearchResponseMerger> supplier)

Parameters:

supplier - Attach a Supplier of SearchResponseMerger to this task. For use with CCS minimize_roundtrips=true