Package org.opensearch.search.pipeline

Interface SearchPhaseResultsProcessor

All Superinterfaces:

Processor

public interface SearchPhaseResultsProcessor
extends Processor

Creates a processor that runs between Phases of the Search.

Opensearch.api:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.search.pipeline.Processor

Processor.Factory<T extends Processor>, Processor.PipelineContext, Processor.PipelineSource

Method Summary

Modifier and Type	Method	Description
SearchPhaseName	getAfterPhase()	The phase which should run after, this processor execution.
SearchPhaseName	getBeforePhase()	The phase which should have run before, this processor can start executing.
<Result extends SearchPhaseResult> void	process(SearchPhaseResults<Result> searchPhaseResult, SearchPhaseContext searchPhaseContext)	Processes the SearchPhaseResults obtained from a SearchPhase which will be returned to next SearchPhase.
default <Result extends SearchPhaseResult> void	process(SearchPhaseResults<Result> searchPhaseResult, SearchPhaseContext searchPhaseContext, PipelineProcessingContext requestContext)	Processes the SearchPhaseResults obtained from a SearchPhase which will be returned to next SearchPhase.

Methods inherited from interface org.opensearch.search.pipeline.Processor

getDescription, getTag, getType, isIgnoreFailure

Method Details

process

<Result extends SearchPhaseResult> void process(SearchPhaseResults<Result> searchPhaseResult,
 SearchPhaseContext searchPhaseContext)

Processes the SearchPhaseResults obtained from a SearchPhase which will be returned to next SearchPhase.

Type Parameters:

Result - SearchPhaseResult

Parameters:

searchPhaseResult - SearchPhaseResults

searchPhaseContext - SearchContext

process

default <Result extends SearchPhaseResult> void process(SearchPhaseResults<Result> searchPhaseResult,
 SearchPhaseContext searchPhaseContext,
 PipelineProcessingContext requestContext)

Processes the SearchPhaseResults obtained from a SearchPhase which will be returned to next SearchPhase. Receives the PipelineProcessingContext passed to other processors.

Type Parameters:

Result - SearchPhaseResult

Parameters:

searchPhaseResult - SearchPhaseResults

searchPhaseContext - SearchContext

requestContext - PipelineProcessingContext

getBeforePhase

SearchPhaseName getBeforePhase()

The phase which should have run before, this processor can start executing.

Returns:

SearchPhaseName

getAfterPhase

SearchPhaseName getAfterPhase()

The phase which should run after, this processor execution.

Returns:

SearchPhaseName