Package org.opensearch.search.pipeline.common

Class FilterQueryRequestProcessor

java.lang.Object

org.opensearch.search.pipeline.common.FilterQueryRequestProcessor

All Implemented Interfaces:

Processor, SearchRequestProcessor

public class FilterQueryRequestProcessor
extends Object
implements SearchRequestProcessor

This is a SearchRequestProcessor that replaces the incoming query with a BooleanQuery that MUST match the incoming query with a FILTER clause based on the configured query.

Nested Class Summary

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

Processor.Parameters

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
FilterQueryRequestProcessor(String tag, String description, QueryBuilder filterQuery)	Constructor that takes a filter query.

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getTag()
String	getType()
SearchRequest	processRequest(SearchRequest request)

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

Field Details

TYPE

public static final String TYPE

Key to reference this processor type from a search pipeline.

See Also:

• Constant Field Values

Constructor Details

FilterQueryRequestProcessor

public FilterQueryRequestProcessor(String tag,
 String description,
 QueryBuilder filterQuery)

Constructor that takes a filter query.

Parameters:

tag - processor tag

description - processor description

filterQuery - the query that will be added as a filter to incoming queries

Method Details

getType

public String getType()

Specified by:

getType in interface Processor

processRequest

public SearchRequest processRequest(SearchRequest request)
                             throws Exception

Specified by:

processRequest in interface SearchRequestProcessor

Throws:

Exception

getTag

public String getTag()

Specified by:

getTag in interface Processor

getDescription

public String getDescription()

Specified by:

getDescription in interface Processor