Package org.opensearch.client.node

Class NodeClient

java.lang.Object

org.opensearch.client.support.AbstractClient

org.opensearch.client.node.NodeClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Client, OpenSearchClient, Releasable

public class NodeClient
extends AbstractClient

Client that executes actions on the local node.

Field Summary

Fields inherited from class org.opensearch.client.support.AbstractClient

logger, settings

Fields inherited from interface org.opensearch.client.Client

CLIENT_TYPE_SETTING_S

Constructor Summary

Constructors

Constructor	Description
NodeClient(Settings settings, ThreadPool threadPool)

Method Summary

Modifier and Type	Method	Description
void	close()
<Request extends ActionRequest, Response extends ActionResponse> void	doExecute(ActionType<Response> action, Request request, ActionListener<Response> listener)
<Request extends ActionRequest, Response extends ActionResponse> Task	executeLocally(ActionType<Response> action, Request request, ActionListener<Response> listener)	Execute an ActionType locally, returning that Task used to track it, and linking an ActionListener.
<Request extends ActionRequest, Response extends ActionResponse> Task	executeLocally(ActionType<Response> action, Request request, TaskListener<Response> listener)	Execute an ActionType locally, returning that Task used to track it, and linking an TaskListener.
java.lang.String	getLocalNodeId()	The id of the local DiscoveryNode.
NamedWriteableRegistry	getNamedWriteableRegistry()
Client	getRemoteClusterClient(java.lang.String clusterAlias)	Returns a client to a remote cluster with the given cluster alias.
void	initialize(java.util.Map<ActionType,TransportAction> actions, java.util.function.Supplier<java.lang.String> localNodeId, RemoteClusterService remoteClusterService, NamedWriteableRegistry namedWriteableRegistry)

Methods inherited from class org.opensearch.client.support.AbstractClient

admin, bulk, bulk, clearScroll, clearScroll, delete, delete, execute, execute, explain, explain, fieldCaps, fieldCaps, filterWithHeader, get, get, index, index, multiGet, multiGet, multiSearch, multiSearch, multiTermVectors, multiTermVectors, prepareBulk, prepareBulk, prepareClearScroll, prepareDelete, prepareDelete, prepareExplain, prepareFieldCaps, prepareGet, prepareGet, prepareIndex, prepareIndex, prepareIndex, prepareMultiGet, prepareMultiSearch, prepareMultiTermVectors, prepareSearch, prepareSearchScroll, prepareTermVectors, prepareTermVectors, prepareUpdate, prepareUpdate, search, search, searchScroll, searchScroll, settings, termVectors, termVectors, threadPool, update, update

Methods inherited from class java.lang.Object

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

Constructor Details

NodeClient

public NodeClient(Settings settings, ThreadPool threadPool)

Method Details

initialize

public void initialize(java.util.Map<ActionType,TransportAction> actions, java.util.function.Supplier<java.lang.String> localNodeId, RemoteClusterService remoteClusterService, NamedWriteableRegistry namedWriteableRegistry)

close

public void close()

doExecute

public <Request extends ActionRequest, Response extends ActionResponse> void doExecute(ActionType<Response> action, Request request, ActionListener<Response> listener)

Specified by:

doExecute in class AbstractClient

executeLocally

public <Request extends ActionRequest, Response extends ActionResponse> Task executeLocally(ActionType<Response> action, Request request, ActionListener<Response> listener)

Execute an ActionType locally, returning that Task used to track it, and linking an ActionListener. Prefer this method if you don't need access to the task when listening for the response. This is the method used to implement the Client interface.

executeLocally

public <Request extends ActionRequest, Response extends ActionResponse> Task executeLocally(ActionType<Response> action, Request request, TaskListener<Response> listener)

Execute an ActionType locally, returning that Task used to track it, and linking an TaskListener. Prefer this method if you need access to the task when listening for the response.

getLocalNodeId

public java.lang.String getLocalNodeId()

The id of the local DiscoveryNode. Useful for generating task ids from tasks returned by executeLocally(ActionType, ActionRequest, TaskListener).

getRemoteClusterClient

public Client getRemoteClusterClient(java.lang.String clusterAlias)

Description copied from interface: Client

Returns a client to a remote cluster with the given cluster alias.

getNamedWriteableRegistry

public NamedWriteableRegistry getNamedWriteableRegistry()