Package org.opensearch.action.search
package org.opensearch.action.search
Search action.
-
ClassDescriptionTransport Action for clearing a scrollMain controller for clearing a scrollTransport request for clearing a search scrollTransport request builder for clearing a search scrollTransport response for clearing a search scrollAction type for creating PIT reader contextController for creating PIT reader context Phase 1 of create PIT request : Create PIT reader contexts in the associated shards with a temporary keep alive Phase 2 of create PIT : Update PIT reader context with PIT ID and keep alive from request and fail user request if any of the updates in this phase are failed - we clean up PITs in case of such failures.A request to make create point in time against one or more indices.Create point in time response with point in time id and shard success / failuresAction type for deleting point in time searchesThis class captures if deletion of pit is successful along with pit idRequest to delete one or more PIT search contexts based on IDs.Response class for delete pits flow which clears the point in time search contextsAction type to delete a search pipelineRequest to delete a search pipelinePerform the action of deleting a search pipelineInner node get all pits requestInner node get all pits responseRequest to get all active PIT IDs from all nodes of clusterThis class transforms active PIT objects from all nodes to unique PIT objectsAction type for retrieving all PIT reader contexts from nodesAction type to get search pipelinesRequest to get search pipelinestransport response for getting a search pipelinePerform the action of getting a search pipelineThis holds information about pit reader context such as pit id and creation timeA collector that computes the maximum score.Transport action for executing a multi searchA multi search API request.A request builder for multiple search requests.A multi search response.A search response item, holding the actual search response, or an error message if it failed.Search scroll id that has been parsedPit ID along with Id for a search context per node.Service class for PIT reusable functionsAction type to put a new search pipelineRequest to put a search pipelinePerform the action of putting a search pipelineA
ArraySearchPhaseResults
implementation that incrementally reduces aggregation results as shard results are consumed.A failure during a reduce phase (when receiving results from several shards, and reducing them into one or more results and possible actions).Transport action for executing a searchId for a serach context.Id for a search context per node.A wrapper of search action listeners (search results) that unwraps the query result to get the piggybacked queue size and service time EWMA, adding those values to the coordinating nodes'ResponseCollectorService
.Base class for all individual search phases like collecting distributed frequencies, fetching documents, querying shards.This class provide contextual state and access to resources across multiple search phases.Controller for the search phase.The reduced query phaseMain exception thrown when there is an error in the search phaseEnum for different Search Phases in OpenSearchSearchPhaseResults<Result extends SearchPhaseResult>This class acts as a basic result collection that can be extended to do on-the-fly reduction or result processingAnActionListener
for search requests that allows to track progress of theSearchAction
.A listener that allows to track progress of theSearchAction
.A request to execute search against one or more indices (or all).A search action request builder.This class holds request-level context for search queries at the coordinator nodeSearchRequestOperationsCompositeListenerFactory contains listeners registered to search requests, and is responsible for creating theSearchRequestOperationsListener.CompositeListener
with the all listeners enabled at cluster-level and request-level.A listener for search, fetch and context events at the coordinator node levelThe request-level search slow log implementationRequest level search stats to track coordinator level node search latenciesHolder of statistics valuesA response of a search request.Holds info about the clusters that the search was executed on: how many in total, how many of them were successful and how many of them were skipped.Holds info about the clusters that the search was executed on: how many in total, how many of them were successful and how many of them were skipped.Base class that holds the various sections which a search response is composed of (hits, aggs, suggestions etc.) and allows to retrieve them.Transport action for a search scrollTransport request for a search scrollA search scroll action request builder.A class that encapsulates theShardId
and the cluster alias of a shard used during the search action.Extension ofPlainShardIterator
used in the search api, which also holds theOriginalIndices
of the search request (useful especially with cross-cluster search, as each cluster has its own set of original indices) as well as the cluster alias.Task storing information about a currently running search shard request.Task storing information about a currently runningSearchRequest
.SearchTaskRequestOperationsListener subscriber for operations on search tasks resource usages.An encapsulation ofSearchService
operations exposed through transport.A search free context responseSearch type represent the manner at which the search operation is executed.Helper class for common search functionsRepresents a failure to search on a specific shard.Perform transport action to clear a search scrollTransport action for creating PIT reader contextRequest to create pit reader context with keep aliveCreate pit reader context response which holds the contextIdTransport action for deleting point in time searches - supports deleting list and all point in time searchesTransport action to get all active PIT contexts across all nodesPerform action for a multi searchPerform search actionThe single phase search action.Perform the search scrollRequest used to update PIT reader contexts with pitId, keepAlive and creationTimeUpdate PIT context response with creation time, keep alive etc.