Package org.opensearch.search.pipeline.common

Class ScriptRequestProcessor

java.lang.Object

org.opensearch.search.pipeline.AbstractProcessor

org.opensearch.search.pipeline.common.ScriptRequestProcessor

All Implemented Interfaces:

Processor, SearchRequestProcessor

public final class ScriptRequestProcessor
extends AbstractProcessor
implements SearchRequestProcessor

Processor that evaluates a script with a search request in its context and then returns the modified search request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ScriptRequestProcessor.Factory	Factory class for creating ScriptRequestProcessor.

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

Processor.PipelineContext, Processor.PipelineSource

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	Key to reference this processor type from a search pipeline.

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

PIPELINE_SOURCE

Method Summary

Modifier and Type	Method	Description
String	getType()	Returns the type of the processor.
SearchRequest	processRequest(SearchRequest request)	Executes the script with the search request in context.

Methods inherited from class org.opensearch.search.pipeline.AbstractProcessor

getDescription, getTag, isIgnoreFailure

Methods inherited from class java.lang.Object

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

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

getDescription, getTag, isIgnoreFailure

Field Details

TYPE

public static final String TYPE

Key to reference this processor type from a search pipeline.

See Also:

• Constant Field Values

Method Details

processRequest

public SearchRequest processRequest(SearchRequest request)
                             throws Exception

Executes the script with the search request in context.

Specified by:

processRequest in interface SearchRequestProcessor

Parameters:

request - The search request passed into the script context.

Returns:

The modified search request.

Throws:

Exception - if an error occurs while processing the request.

getType

public String getType()

Returns the type of the processor.

Specified by:

getType in interface Processor

Returns:

The processor type.