Package org.opensearch.search.pipeline

Interface StatefulSearchResponseProcessor

All Superinterfaces:

Processor, SearchResponseProcessor

public interface StatefulSearchResponseProcessor
extends SearchResponseProcessor

A specialization of SearchResponseProcessor that makes use of the request-scoped processor state. Implementors must implement the processResponse method that accepts request-scoped processor state.

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
default SearchResponse	processResponse(SearchRequest request, SearchResponse response)	Transform a SearchResponse, possibly based on the executed SearchRequest.
SearchResponse	processResponse(SearchRequest request, SearchResponse response, PipelineProcessingContext requestContext)	Process a SearchResponse, with request-scoped state shared across processors in the pipeline

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

getDescription, getTag, getType, isIgnoreFailure

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

processResponseAsync

Method Details

processResponse

default SearchResponse processResponse(SearchRequest request,
 SearchResponse response)

Description copied from interface: SearchResponseProcessor

Transform a SearchResponse, possibly based on the executed SearchRequest.

Implement this method if the processor makes no asynchronous calls.

Specified by:

processResponse in interface SearchResponseProcessor

Parameters:

request - the executed SearchRequest

response - the current SearchResponse, possibly modified by earlier processors

Returns:

a modified SearchResponse (or the input SearchResponse if no changes)

processResponse

SearchResponse processResponse(SearchRequest request,
 SearchResponse response,
 PipelineProcessingContext requestContext)
                        throws Exception

Description copied from interface: SearchResponseProcessor

Process a SearchResponse, with request-scoped state shared across processors in the pipeline

Implement this method if the processor makes no asynchronous calls.

Specified by:

processResponse in interface SearchResponseProcessor

Parameters:

request - the (maybe transformed) search request

response - the search response (which may have been modified by an earlier processor)

requestContext - request-scoped state shared across processors in the pipeline

Returns:

the modified search response

Throws:

Exception - implementation-specific processing exception