java.lang.Object
org.elasticsearch.tasks.Task
org.elasticsearch.tasks.CancellableTask
org.elasticsearch.action.search.SearchTask
- All Implemented Interfaces:
Traceable
Task storing information about a currently running
SearchRequest.-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.tasks.CancellableTask
CancellableTask.CancellationListenerNested 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_ELASTIC_PROJECT_ID_HTTP_HEADER, X_OPAQUE_ID_HTTP_HEADER -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal StringGenerates task descriptionfinal SearchProgressListenerReturn theSearchProgressListenerattached to this task.booleanisAsync()Is this async search?final voidsetProgressListener(SearchProgressListener progressListener) Attach aSearchProgressListenerto this task.voidMethods inherited from class org.elasticsearch.tasks.CancellableTask
addListener, ensureNotCancelled, getReasonCancelled, isCancelled, notifyIfCancelled, onCancelled, shouldCancelChildrenOnCancellation, toStringMethods inherited from class org.elasticsearch.tasks.Task
getAction, getHeader, getId, getParentTaskId, getProjectId, getSpanId, getStartTime, getStartTimeNanos, getStatus, getType, headers, result, result, taskInfo, taskInfo
-
Constructor Details
-
SearchTask
-
-
Method Details
-
getDescription
Description copied from class:TaskGenerates task description- Overrides:
getDescriptionin classTask
-
setProgressListener
Attach aSearchProgressListenerto this task. -
getProgressListener
Return theSearchProgressListenerattached to this task. -
getSearchResponseMergerSupplier
- Returns:
- the Supplier of
SearchResponseMergerattached to this task. Will be null for local-only search and cross-cluster searches with minimize_roundtrips=false.
-
setSearchResponseMergerSupplier
- Parameters:
supplier- Attach a Supplier ofSearchResponseMergerto this task. For use with CCS minimize_roundtrips=true
-
isAsync
public boolean isAsync()Is this async search?
-