java.lang.Object

org.opensearch.action.search.SearchShardTask

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.opensearch.tasks.Task
Task.Status
Field Summary

Fields inherited from class org.opensearch.tasks.Task
X_OPAQUE_ID

Constructor Summary

Constructors
Constructor	Description
`SearchShardTask(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.

cancelOnParentLeaving, getCancellationTimeout, getReasonCancelled, isCancelled, onCancelled

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

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

Constructor Details
- SearchShardTask
  
  public SearchShardTask(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 Details
- 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