java.lang.Object

org.opensearch.action.search.SearchTransportService

public class SearchTransportService
extends java.lang.Object

An encapsulation of SearchService operations exposed through transport.

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class SearchTransportService.SearchFreeContextResponse

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`CLEAR_SCROLL_CONTEXTS_ACTION_NAME`
`static java.lang.String`	`DFS_ACTION_NAME`
`static java.lang.String`	`FETCH_ID_ACTION_NAME`
`static java.lang.String`	`FETCH_ID_SCROLL_ACTION_NAME`
`static java.lang.String`	`FREE_CONTEXT_ACTION_NAME`
`static java.lang.String`	`FREE_CONTEXT_SCROLL_ACTION_NAME`
`static java.lang.String`	`QUERY_ACTION_NAME`
`static java.lang.String`	`QUERY_CAN_MATCH_NAME`
`static java.lang.String`	`QUERY_FETCH_SCROLL_ACTION_NAME`
`static java.lang.String`	`QUERY_ID_ACTION_NAME`
`static java.lang.String`	`QUERY_SCROLL_ACTION_NAME`

Constructor Summary

Constructors
Constructor	Description
`SearchTransportService(TransportService transportService, java.util.function.BiFunction<Transport.Connection,org.opensearch.action.search.SearchActionListener,ActionListener> responseWrapper)`

Method Summary

Modifier and Type	Method	Description
`Transport.Connection`	`getConnection(java.lang.String clusterAlias, DiscoveryNode node)`	Returns a connection to the given node on the provided cluster.
`java.util.Map<java.lang.String,java.lang.Long>`	`getPendingSearchRequests()`	Return a map of nodeId to pending number of search requests.
`RemoteClusterService`	`getRemoteClusterService()`
`static void`	`registerRequestHandler(TransportService transportService, SearchService searchService)`
`void`	`sendCanMatch(Transport.Connection connection, ShardSearchRequest request, SearchTask task, ActionListener<SearchService.CanMatchResponse> listener)`
`void`	`sendClearAllScrollContexts(Transport.Connection connection, ActionListener<TransportResponse> listener)`
`void`	`sendExecuteDfs(Transport.Connection connection, ShardSearchRequest request, SearchTask task, org.opensearch.action.search.SearchActionListener<DfsSearchResult> listener)`
`void`	`sendExecuteFetch(Transport.Connection connection, ShardFetchSearchRequest request, SearchTask task, org.opensearch.action.search.SearchActionListener<FetchSearchResult> listener)`
`void`	`sendExecuteFetchScroll(Transport.Connection connection, ShardFetchRequest request, SearchTask task, org.opensearch.action.search.SearchActionListener<FetchSearchResult> listener)`
`void`	`sendExecuteQuery(Transport.Connection connection, ShardSearchRequest request, SearchTask task, org.opensearch.action.search.SearchActionListener<SearchPhaseResult> listener)`
`void`	`sendExecuteQuery(Transport.Connection connection, QuerySearchRequest request, SearchTask task, org.opensearch.action.search.SearchActionListener<QuerySearchResult> listener)`
`void`	`sendExecuteScrollFetch(Transport.Connection connection, InternalScrollSearchRequest request, SearchTask task, org.opensearch.action.search.SearchActionListener<ScrollQueryFetchSearchResult> listener)`
`void`	`sendExecuteScrollQuery(Transport.Connection connection, InternalScrollSearchRequest request, SearchTask task, org.opensearch.action.search.SearchActionListener<ScrollQuerySearchResult> listener)`
`void`	`sendFreeContext(Transport.Connection connection, ShardSearchContextId contextId, ActionListener<SearchTransportService.SearchFreeContextResponse> listener)`
`void`	`sendFreeContext(Transport.Connection connection, ShardSearchContextId contextId, OriginalIndices originalIndices)`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- FREE_CONTEXT_SCROLL_ACTION_NAME
  
  public static final java.lang.String FREE_CONTEXT_SCROLL_ACTION_NAME
  
  See Also:
  
  Constant Field Values
- FREE_CONTEXT_ACTION_NAME
  
  public static final java.lang.String FREE_CONTEXT_ACTION_NAME
  
  See Also:
  
  Constant Field Values
- CLEAR_SCROLL_CONTEXTS_ACTION_NAME
  
  public static final java.lang.String CLEAR_SCROLL_CONTEXTS_ACTION_NAME
  
  See Also:
  
  Constant Field Values
- DFS_ACTION_NAME
  
  public static final java.lang.String DFS_ACTION_NAME
  
  See Also:
  
  Constant Field Values
- QUERY_ACTION_NAME
  
  public static final java.lang.String QUERY_ACTION_NAME
  
  See Also:
  
  Constant Field Values
- QUERY_ID_ACTION_NAME
  
  public static final java.lang.String QUERY_ID_ACTION_NAME
  
  See Also:
  
  Constant Field Values
- QUERY_SCROLL_ACTION_NAME
  
  public static final java.lang.String QUERY_SCROLL_ACTION_NAME
  
  See Also:
  
  Constant Field Values
- QUERY_FETCH_SCROLL_ACTION_NAME
  
  public static final java.lang.String QUERY_FETCH_SCROLL_ACTION_NAME
  
  See Also:
  
  Constant Field Values
- FETCH_ID_SCROLL_ACTION_NAME
  
  public static final java.lang.String FETCH_ID_SCROLL_ACTION_NAME
  
  See Also:
  
  Constant Field Values
- FETCH_ID_ACTION_NAME
  
  public static final java.lang.String FETCH_ID_ACTION_NAME
  
  See Also:
  
  Constant Field Values
- QUERY_CAN_MATCH_NAME
  
  public static final java.lang.String QUERY_CAN_MATCH_NAME
  
  See Also:
  
  Constant Field Values
Constructor Details
- SearchTransportService
  
  public SearchTransportService(TransportService transportService, java.util.function.BiFunction<Transport.Connection,org.opensearch.action.search.SearchActionListener,ActionListener> responseWrapper)
Method Details
- sendFreeContext
  
  public void sendFreeContext(Transport.Connection connection, ShardSearchContextId contextId, OriginalIndices originalIndices)
- sendFreeContext
  
  public void sendFreeContext(Transport.Connection connection, ShardSearchContextId contextId, ActionListener<SearchTransportService.SearchFreeContextResponse> listener)
- sendCanMatch
  
  public void sendCanMatch(Transport.Connection connection, ShardSearchRequest request, SearchTask task, ActionListener<SearchService.CanMatchResponse> listener)
- sendClearAllScrollContexts
  
  public void sendClearAllScrollContexts(Transport.Connection connection, ActionListener<TransportResponse> listener)
- sendExecuteDfs
  
  public void sendExecuteDfs(Transport.Connection connection, ShardSearchRequest request, SearchTask task, org.opensearch.action.search.SearchActionListener<DfsSearchResult> listener)
- sendExecuteQuery
  
  public void sendExecuteQuery(Transport.Connection connection, ShardSearchRequest request, SearchTask task, org.opensearch.action.search.SearchActionListener<SearchPhaseResult> listener)
- sendExecuteQuery
  
  public void sendExecuteQuery(Transport.Connection connection, QuerySearchRequest request, SearchTask task, org.opensearch.action.search.SearchActionListener<QuerySearchResult> listener)
- sendExecuteScrollQuery
  
  public void sendExecuteScrollQuery(Transport.Connection connection, InternalScrollSearchRequest request, SearchTask task, org.opensearch.action.search.SearchActionListener<ScrollQuerySearchResult> listener)
- sendExecuteScrollFetch
  
  public void sendExecuteScrollFetch(Transport.Connection connection, InternalScrollSearchRequest request, SearchTask task, org.opensearch.action.search.SearchActionListener<ScrollQueryFetchSearchResult> listener)
- sendExecuteFetch
  
  public void sendExecuteFetch(Transport.Connection connection, ShardFetchSearchRequest request, SearchTask task, org.opensearch.action.search.SearchActionListener<FetchSearchResult> listener)
- sendExecuteFetchScroll
  
  public void sendExecuteFetchScroll(Transport.Connection connection, ShardFetchRequest request, SearchTask task, org.opensearch.action.search.SearchActionListener<FetchSearchResult> listener)
- getRemoteClusterService
  
  public RemoteClusterService getRemoteClusterService()
- getPendingSearchRequests
  
  public java.util.Map<java.lang.String,java.lang.Long> getPendingSearchRequests()
  
  Return a map of nodeId to pending number of search requests. This is a snapshot of the current pending search and not a live map.
- registerRequestHandler
  
  public static void registerRequestHandler(TransportService transportService, SearchService searchService)
- getConnection
  
  public Transport.Connection getConnection(@Nullable java.lang.String clusterAlias, DiscoveryNode node)
  
  Returns a connection to the given node on the provided cluster. If the cluster alias is null the node will be resolved against the local cluster.
  
  Parameters:
  
  clusterAlias - the cluster alias the node should be resolved against
  
  node - the node to resolve
  
  Returns:
  
  a connection to the given node belonging to the cluster with the provided alias.

Class SearchTransportService

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details