SearchRequestContext (server 2.17.1 API)

java.lang.Object

org.opensearch.action.search.SearchRequestContext

@InternalApi public class SearchRequestContext extends Object

This class holds request-level context for search queries at the coordinator node

Opensearch.internal:

Method Summary

Modifier and Type

Method

Description

long

getAbsoluteStartNanos()

Request start time in nanos

List<org.opensearch.core.tasks.resourcetracker.TaskResourceInfo>

getPhaseResourceUsage()

SearchRequest

getRequest()

Supplier<org.opensearch.core.tasks.resourcetracker.TaskResourceInfo>

getTaskResourceUsageSupplier()

Map<String,Long>

phaseTookMap()

void

recordPhaseResourceUsage(org.opensearch.core.tasks.resourcetracker.TaskResourceInfo usage)

org.apache.lucene.search.TotalHits

totalHits()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- phaseTookMap
  
  public Map<String,Long> phaseTookMap()
- getAbsoluteStartNanos
  
  public long getAbsoluteStartNanos()
  
  Request start time in nanos
- totalHits
  
  public org.apache.lucene.search.TotalHits totalHits()
- getTaskResourceUsageSupplier
  
  public Supplier<org.opensearch.core.tasks.resourcetracker.TaskResourceInfo> getTaskResourceUsageSupplier()
- recordPhaseResourceUsage
  
  public void recordPhaseResourceUsage(org.opensearch.core.tasks.resourcetracker.TaskResourceInfo usage)
- getPhaseResourceUsage
  
  public List<org.opensearch.core.tasks.resourcetracker.TaskResourceInfo> getPhaseResourceUsage()
- getRequest
  
  public SearchRequest getRequest()