Index (search-pipeline-common 2.11.1 API)

C E F G I K M O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

C

clear() - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Removes all properties from the SearchSourceBuilder.
compute(String, BiFunction<? super String, ? super Object, ?>) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: If the value for the specified property is present, attempts to compute a new mapping given the property and its current mapped value, or removes the property if the computed value is null.
computeIfAbsent(String, Function<? super String, ?>) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: The computed value associated with the property, or null if the property is not present.
computeIfPresent(String, BiFunction<? super String, ? super Object, ?>) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: If the value for the specified property is present, attempts to compute a new mapping given the property and its current mapped value.
containsKey(Object) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Checks if the SearchSourceBuilder contains the specified property.
containsValue(Object) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Checks if the SearchSourceBuilder contains the specified value.
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

E

entrySet() - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Returns a set view of the properties in the SearchSourceBuilder.

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.
forEach(BiConsumer<? super String, ? super Object>) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Performs the given action for each property in the SearchSourceBuilder until all properties have been processed or the action throws an exception

G

get(Object) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Retrieves the value associated with the specified property from the SearchSourceBuilder.
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
getOrDefault(Object, Object) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Returns the value to which the specified property has, or the defaultValue if the property is not present in the SearchSourceBuilder.
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
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.RenameFieldResponseProcessor
getType() - Method in class org.opensearch.search.pipeline.common.ScriptRequestProcessor: Returns the type of the processor.

I

isEmpty() - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Checks if the SearchSourceBuilder is empty.
isIgnoreMissing() - Method in class org.opensearch.search.pipeline.common.RenameFieldResponseProcessor: Getter function for ignoreMissing

K

keySet() - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Returns a set view of the property names in the SearchSourceBuilder.

M

merge(String, Object, BiFunction<? super Object, ? super Object, ?>) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: If the specified property is not already associated with a value or is associated with null, associates it with the given non-null value.

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.

P

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) - Method in class org.opensearch.search.pipeline.common.ScriptRequestProcessor: Executes the script with the search request in context.
processResponse(SearchRequest, SearchResponse) - Method in class org.opensearch.search.pipeline.common.RenameFieldResponseProcessor
put(String, Object) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Sets the value for the specified property in the SearchSourceBuilder.
putAll(Map<? extends String, ?>) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Sets all the properties from the specified map to the SearchSourceBuilder.
putIfAbsent(String, Object) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: If the specified property is not already associated with a value, associates it with the given value and returns null, else returns the current value.

R

remove(Object) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Removes the specified property from the SearchSourceBuilder.
remove(Object, Object) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Removes the property only if it has the given value.
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
replace(String, Object) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Replaces the specified property only if it has the given value.
replace(String, Object, Object) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Replaces the specified property only if it has the given value.
replaceAll(BiFunction<? super String, ? super Object, ?>) - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Replaces each property's value with the result of invoking the given function on that property until all properties have been processed or the function throws an exception.

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.
SearchRequestMap - Class in org.opensearch.search.pipeline.common.helpers: A custom implementation of Map that provides access to the properties of a SearchRequest's SearchSourceBuilder.
SearchRequestMap(SearchRequest) - Constructor for class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Constructs a new instance of the SearchRequestMap with the provided SearchRequest.
SearchRequestMapProcessingException - Exception in org.opensearch.search.pipeline.common.helpers: An exception that indicates an error occurred while processing a SearchRequestMap.
SearchRequestMapProcessingException(String, Object...) - Constructor for exception org.opensearch.search.pipeline.common.helpers.SearchRequestMapProcessingException: Constructs a new SearchRequestMapProcessingException with the specified message.
SearchRequestMapProcessingException(String, Throwable, Object...) - Constructor for exception org.opensearch.search.pipeline.common.helpers.SearchRequestMapProcessingException: Constructs a new SearchRequestMapProcessingException with the specified message and cause.
size() - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Retrieves the number of properties in the SearchSourceBuilder.

T

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.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.

V

values() - Method in class org.opensearch.search.pipeline.common.helpers.SearchRequestMap: Returns a collection view of the property values in the SearchSourceBuilder.

C E F G I K M O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form