Package org.opensearch.action.search

Class SearchPhase

java.lang.Object

org.opensearch.action.search.SearchPhase

All Implemented Interfaces:

org.opensearch.common.CheckedRunnable<IOException>

@PublicApi(since="1.0.0")
public abstract class SearchPhase
extends Object
implements org.opensearch.common.CheckedRunnable<IOException>

Base class for all individual search phases like collecting distributed frequencies, fetching documents, querying shards.

Opensearch.api:

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SearchPhase(String name)

Method Summary

Modifier and Type	Method	Description
String	getName()	Returns the phases name.
SearchPhaseName	getSearchPhaseName()	Returns the SearchPhase name as SearchPhaseName.
long	getStartTimeInNanos()
void	recordAndRun()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.common.CheckedRunnable

run

Constructor Details

SearchPhase

protected SearchPhase(String name)

Method Details

getStartTimeInNanos

public long getStartTimeInNanos()

recordAndRun

public void recordAndRun()
                  throws IOException

Throws:

IOException

getName

public String getName()

Returns the phases name.

getSearchPhaseName

public SearchPhaseName getSearchPhaseName()

Returns the SearchPhase name as SearchPhaseName. Exception will come if SearchPhase name is not defined in SearchPhaseName

Returns:

SearchPhaseName