Package org.opensearch.search.pipeline.common

Class SortResponseProcessor

java.lang.Object

org.opensearch.search.pipeline.AbstractProcessor

org.opensearch.search.pipeline.common.SortResponseProcessor

All Implemented Interfaces:

Processor, SearchResponseProcessor

public class SortResponseProcessor
extends AbstractProcessor
implements SearchResponseProcessor

Processor that sorts an array of items. Throws exception is the specified field is not an array.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SortResponseProcessor.SortOrder	Enum defining how elements will be sorted

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	DEFAULT_ORDER	Default sort order if not specified
static final String	SORT_FIELD	Key defining the array field to be sorted.
static final String	SORT_ORDER	Optional key defining the sort order.
static final String	TARGET_FIELD	Optional key to put the sorted values in a different field.
static final String	TYPE	Key to reference this processor type from a search pipeline.

Method Summary

Modifier and Type	Method	Description
String	getSortField()	Getter function for sortField
SortResponseProcessor.SortOrder	getSortOrder()	Getter function for sortOrder
String	getTargetField()	Getter function for targetField
String	getType()
SearchResponse	processResponse(SearchRequest request, SearchResponse response)

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

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

processResponse, processResponseAsync

Field Details

TYPE

public static final String TYPE

Key to reference this processor type from a search pipeline.

See Also:

• Constant Field Values

SORT_FIELD

public static final String SORT_FIELD

Key defining the array field to be sorted.

See Also:

• Constant Field Values

SORT_ORDER

public static final String SORT_ORDER

Optional key defining the sort order.

See Also:

• Constant Field Values

TARGET_FIELD

public static final String TARGET_FIELD

Optional key to put the sorted values in a different field.

See Also:

• Constant Field Values

DEFAULT_ORDER

public static final String DEFAULT_ORDER

Default sort order if not specified

See Also:

• Constant Field Values

Method Details

getSortField

public String getSortField()

Getter function for sortField

Returns:

sortField

getTargetField

public String getTargetField()

Getter function for targetField

Returns:

targetField

getSortOrder

public SortResponseProcessor.SortOrder getSortOrder()

Getter function for sortOrder

Returns:

sortOrder

getType

public String getType()

Specified by:

getType in interface Processor

processResponse

public SearchResponse processResponse(SearchRequest request,
 SearchResponse response)
                               throws Exception

Specified by:

processResponse in interface SearchResponseProcessor

Throws:

Exception