Index (search-pipeline-common 2.16.0 API)

A C D F G I O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values

A

applyContextPrefix(String, String) - Static method in class org.opensearch.search.pipeline.common.helpers.ContextUtils: Replaces a "global" variable name with one scoped to a given context prefix (unless prefix is null or empty).
ASCENDING - Enum constant in enum org.opensearch.search.pipeline.common.SortResponseProcessor.SortOrder: Sort in ascending (natural) order

C

CollapseResponseProcessor - Class in org.opensearch.search.pipeline.common: A simple implementation of field collapsing on search responses.
CONTEXT_PREFIX_PARAMETER - Static variable in class org.opensearch.search.pipeline.common.helpers.ContextUtils: Parameter that can be passed to a stateful processor to avoid collisions between contextual variables by prefixing them with distinct qualifiers.
ContextUtils - Class in org.opensearch.search.pipeline.common.helpers: Helpers for working with request-scoped context.
create(Map<String, Processor.Factory<SearchRequestProcessor>>, String, String, boolean, Map<String, Object>, Processor.PipelineContext) - Method in class org.opensearch.search.pipeline.common.ScriptRequestProcessor.Factory
create(Map<String, Processor.Factory<SearchResponseProcessor>>, String, String, boolean, Map<String, Object>, Processor.PipelineContext) - Method in class org.opensearch.search.pipeline.common.RenameFieldResponseProcessor.Factory

D

DEFAULT_ORDER - Static variable in class org.opensearch.search.pipeline.common.SortResponseProcessor: Default sort order if not specified
DESCENDING - Enum constant in enum org.opensearch.search.pipeline.common.SortResponseProcessor.SortOrder: Sort in descending (reverse) order

F

Factory(ScriptService) - Constructor for class org.opensearch.search.pipeline.common.ScriptRequestProcessor.Factory: Constructs a new Factory instance with the specified ScriptService.
FilterQueryRequestProcessor - Class in org.opensearch.search.pipeline.common: 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.
fromString(String) - Static method in enum org.opensearch.search.pipeline.common.SortResponseProcessor.SortOrder: Converts the string representation of the enum value to the enum.

G

getNewField() - Method in class org.opensearch.search.pipeline.common.RenameFieldResponseProcessor: Getter function for newField
getOldField() - Method in class org.opensearch.search.pipeline.common.RenameFieldResponseProcessor: Getter function for oldField
getRequestProcessors(SearchPipelinePlugin.Parameters) - Method in class org.opensearch.search.pipeline.common.SearchPipelineCommonModulePlugin: Returns a map of processor factories.
getResponseProcessors(SearchPipelinePlugin.Parameters) - Method in class org.opensearch.search.pipeline.common.SearchPipelineCommonModulePlugin
getSearchPhaseResultsProcessors(SearchPipelinePlugin.Parameters) - Method in class org.opensearch.search.pipeline.common.SearchPipelineCommonModulePlugin
getSeparator() - Method in class org.opensearch.search.pipeline.common.SplitResponseProcessor: Getter function for separator
getSettings() - Method in class org.opensearch.search.pipeline.common.SearchPipelineCommonModulePlugin
getSortField() - Method in class org.opensearch.search.pipeline.common.SortResponseProcessor: Getter function for sortField
getSortOrder() - Method in class org.opensearch.search.pipeline.common.SortResponseProcessor: Getter function for sortOrder
getSplitField() - Method in class org.opensearch.search.pipeline.common.SplitResponseProcessor: Getter function for splitField
getTargetField() - Method in class org.opensearch.search.pipeline.common.SortResponseProcessor: Getter function for targetField
getTargetField() - Method in class org.opensearch.search.pipeline.common.SplitResponseProcessor: Getter function for targetField
getType() - Method in class org.opensearch.search.pipeline.common.CollapseResponseProcessor
getType() - Method in class org.opensearch.search.pipeline.common.FilterQueryRequestProcessor: Returns the type of the processor.
getType() - Method in class org.opensearch.search.pipeline.common.OversampleRequestProcessor
getType() - Method in class org.opensearch.search.pipeline.common.RenameFieldResponseProcessor
getType() - Method in class org.opensearch.search.pipeline.common.ScriptRequestProcessor: Returns the type of the processor.
getType() - Method in class org.opensearch.search.pipeline.common.SortResponseProcessor
getType() - Method in class org.opensearch.search.pipeline.common.SplitResponseProcessor
getType() - Method in class org.opensearch.search.pipeline.common.TruncateHitsResponseProcessor

I

isIgnoreMissing() - Method in class org.opensearch.search.pipeline.common.RenameFieldResponseProcessor: Getter function for ignoreMissing
isPreserveTrailing() - Method in class org.opensearch.search.pipeline.common.SplitResponseProcessor: Getter function for preserveTrailing

O

org.opensearch.search.pipeline.common - package org.opensearch.search.pipeline.common: A collection of commonly-useful request and response processors for use in search pipelines.
org.opensearch.search.pipeline.common.helpers - package org.opensearch.search.pipeline.common.helpers: Provides helper classes and utilities for working with search pipeline processors.
OversampleRequestProcessor - Class in org.opensearch.search.pipeline.common: Multiplies the "size" parameter on the SearchRequest by the given scaling factor, storing the original value in the request context as "original_size".

P

PRESERVE_TRAILING - Static variable in class org.opensearch.search.pipeline.common.SplitResponseProcessor: Optional key for handling empty trailing fields.
processRequest(SearchRequest) - Method in class org.opensearch.search.pipeline.common.FilterQueryRequestProcessor: Modifies the search request by adding a filtered query to the existing query, if any, and sets it as the new query in the search request's SearchSourceBuilder.
processRequest(SearchRequest, PipelineProcessingContext) - Method in class org.opensearch.search.pipeline.common.OversampleRequestProcessor
processRequest(SearchRequest, PipelineProcessingContext) - Method in class org.opensearch.search.pipeline.common.ScriptRequestProcessor
processResponse(SearchRequest, SearchResponse) - Method in class org.opensearch.search.pipeline.common.CollapseResponseProcessor
processResponse(SearchRequest, SearchResponse) - Method in class org.opensearch.search.pipeline.common.RenameFieldResponseProcessor
processResponse(SearchRequest, SearchResponse) - Method in class org.opensearch.search.pipeline.common.SortResponseProcessor
processResponse(SearchRequest, SearchResponse) - Method in class org.opensearch.search.pipeline.common.SplitResponseProcessor
processResponse(SearchRequest, SearchResponse, PipelineProcessingContext) - Method in class org.opensearch.search.pipeline.common.TruncateHitsResponseProcessor

R

RenameFieldResponseProcessor - Class in org.opensearch.search.pipeline.common: This is a SearchRequestProcessor that renames a field before returning the search response
RenameFieldResponseProcessor(String, String, boolean, String, String, boolean) - Constructor for class org.opensearch.search.pipeline.common.RenameFieldResponseProcessor: Constructor that takes a target field to rename and the new name
RenameFieldResponseProcessor.Factory - Class in org.opensearch.search.pipeline.common: This is a factor that creates the RenameResponseProcessor
replaceHits(SearchHit[], SearchResponse) - Static method in class org.opensearch.search.pipeline.common.helpers.SearchResponseUtil: Convenience method when only replacing the SearchHit array within the SearchHits in a SearchResponse.
replaceHits(SearchHits, SearchResponse) - Static method in class org.opensearch.search.pipeline.common.helpers.SearchResponseUtil: Construct a new SearchResponse based on an existing one, replacing just the SearchHits.

S

ScriptRequestProcessor - Class in org.opensearch.search.pipeline.common: Processor that evaluates a script with a search request in its context and then returns the modified search request.
ScriptRequestProcessor.Factory - Class in org.opensearch.search.pipeline.common: Factory class for creating ScriptRequestProcessor.
SearchPipelineCommonModulePlugin - Class in org.opensearch.search.pipeline.common: Plugin providing common search request/response processors for use in search pipelines.
SearchPipelineCommonModulePlugin() - Constructor for class org.opensearch.search.pipeline.common.SearchPipelineCommonModulePlugin: No constructor needed, but build complains if we don't have a constructor with JavaDoc.
SearchResponseUtil - Class in org.opensearch.search.pipeline.common.helpers: Helper methods for manipulating SearchResponse.
SEPARATOR - Static variable in class org.opensearch.search.pipeline.common.SplitResponseProcessor: Key defining the delimiter used to split the string.
SORT_FIELD - Static variable in class org.opensearch.search.pipeline.common.SortResponseProcessor: Key defining the array field to be sorted.
SORT_ORDER - Static variable in class org.opensearch.search.pipeline.common.SortResponseProcessor: Optional key defining the sort order.
SortResponseProcessor - Class in org.opensearch.search.pipeline.common: Processor that sorts an array of items.
SortResponseProcessor.SortOrder - Enum in org.opensearch.search.pipeline.common: Enum defining how elements will be sorted
SPLIT_FIELD - Static variable in class org.opensearch.search.pipeline.common.SplitResponseProcessor: Key defining the string field to be split.
SplitResponseProcessor - Class in org.opensearch.search.pipeline.common: Processor that sorts an array of items.

T

TARGET_FIELD - Static variable in class org.opensearch.search.pipeline.common.SortResponseProcessor: Optional key to put the sorted values in a different field.
TARGET_FIELD - Static variable in class org.opensearch.search.pipeline.common.SplitResponseProcessor: Optional key to put the split values in a different field.
toString() - Method in enum org.opensearch.search.pipeline.common.SortResponseProcessor.SortOrder
TruncateHitsResponseProcessor - Class in org.opensearch.search.pipeline.common: Truncates the returned search hits from the SearchResponse.
TYPE - Static variable in class org.opensearch.search.pipeline.common.CollapseResponseProcessor: Key to reference this processor type from a search pipeline.
TYPE - Static variable in class org.opensearch.search.pipeline.common.FilterQueryRequestProcessor: Key to reference this processor type from a search pipeline.
TYPE - Static variable in class org.opensearch.search.pipeline.common.OversampleRequestProcessor: Key to reference this processor type from a search pipeline.
TYPE - Static variable in class org.opensearch.search.pipeline.common.RenameFieldResponseProcessor: Key to reference this processor type from a search pipeline.
TYPE - Static variable in class org.opensearch.search.pipeline.common.ScriptRequestProcessor: Key to reference this processor type from a search pipeline.
TYPE - Static variable in class org.opensearch.search.pipeline.common.SortResponseProcessor: Key to reference this processor type from a search pipeline.
TYPE - Static variable in class org.opensearch.search.pipeline.common.SplitResponseProcessor: Key to reference this processor type from a search pipeline.
TYPE - Static variable in class org.opensearch.search.pipeline.common.TruncateHitsResponseProcessor: Key to reference this processor type from a search pipeline.

V

valueOf(String) - Static method in enum org.opensearch.search.pipeline.common.SortResponseProcessor.SortOrder: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.opensearch.search.pipeline.common.SortResponseProcessor.SortOrder: Returns an array containing the constants of this enum type, in the order they are declared.

A C D F G I O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values