Package org.opensearch.action.search

Class SearchTask

java.lang.Object

org.opensearch.tasks.Task

org.opensearch.tasks.CancellableTask

org.opensearch.action.search.SearchTask

public class SearchTask
extends CancellableTask

Task storing information about a currently running SearchRequest.

Opensearch.internal:

Nested Class Summary

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

Task.Status

Field Summary

Fields inherited from class org.opensearch.tasks.Task

X_OPAQUE_ID

Constructor Summary

Constructors

Constructor	Description
SearchTask(long id, String type, String action, Supplier<String> descriptionSupplier, TaskId parentTaskId, Map<String,String> headers)
SearchTask(long id, String type, String action, Supplier<String> descriptionSupplier, TaskId parentTaskId, Map<String,String> headers, org.opensearch.common.unit.TimeValue cancelAfterTimeInterval)

Method Summary

Modifier and Type	Method	Description
final String	getDescription()	Generates task description
final SearchProgressListener	getProgressListener()	Return the SearchProgressListener attached to this task.
final void	setProgressListener(SearchProgressListener progressListener)	Attach a SearchProgressListener to this task.
boolean	shouldCancelChildrenOnCancellation()	Returns true if this task can potentially have children that need to be cancelled when it parent is cancelled.
boolean	supportsResourceTracking()	Individual tasks can override this if they want to support task resource tracking.

Methods inherited from class org.opensearch.tasks.CancellableTask

cancelOnParentLeaving, getCancellationTimeout, getReasonCancelled, isCancelled, onCancelled

Methods inherited from class org.opensearch.tasks.Task

addResourceTrackingCompletionListener, decrementResourceTrackingThreads, getAction, getHeader, getId, getParentTaskId, getResourceStats, getStartTime, getStartTimeNanos, getStatus, getTotalResourceStats, getTotalResourceUtilization, getType, incrementResourceTrackingThreads, result, result, startThreadResourceTracking, stopThreadResourceTracking, taskInfo, taskInfo, taskInfo, updateThreadResourceStats

Methods inherited from class java.lang.Object

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

Constructor Details

SearchTask

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

SearchTask

public SearchTask(long id,
 String type,
 String action,
 Supplier<String> descriptionSupplier,
 TaskId parentTaskId,
 Map<String,String> headers,
 org.opensearch.common.unit.TimeValue cancelAfterTimeInterval)

Method Details

getDescription

public final String getDescription()

Description copied from class: Task

Generates task description

Overrides:

getDescription in class Task

supportsResourceTracking

public boolean supportsResourceTracking()

Description copied from class: Task

Individual tasks can override this if they want to support task resource tracking. We just need to make sure that the ThreadPool on which the task runs on have runnable wrapper similar to OpenSearchExecutors.newAutoQueueFixed(java.lang.String, int, int, int, int, int, org.opensearch.common.unit.TimeValue, java.util.concurrent.ThreadFactory, org.opensearch.common.util.concurrent.ThreadContext)

Overrides:

supportsResourceTracking in class Task

Returns:

true if resource tracking is supported by the 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.

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