Package org.opensearch.test.client

Class NoOpNodeClient

java.lang.Object
org.opensearch.client.support.AbstractClient
org.opensearch.client.node.NodeClient
org.opensearch.test.client.NoOpNodeClient
All Implemented Interfaces:
java.io.Closeable, java.lang.AutoCloseable, org.opensearch.client.Client, org.opensearch.client.OpenSearchClient, org.opensearch.common.lease.Releasable
Direct Known Subclasses:
RestActionTestCase.VerifyingClient
public class NoOpNodeClient
extends org.opensearch.client.node.NodeClient
Client that always response with null to every request. Override doExecute(ActionType, ActionRequest, ActionListener), executeLocally(ActionType, ActionRequest, ActionListener), or executeLocally(ActionType, ActionRequest, TaskListener) for testing. See also NoOpClient if you do not specifically need a NodeClient.

  • 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
    NoOpNodeClient​(java.lang.String testName)
    Create a new TestThreadPool for this client.
    NoOpNodeClient​(org.opensearch.threadpool.ThreadPool threadPool)
    Build with ThreadPool.

  • Method Summary

    Modifier and Type Method Description
    void close()  
    <Request extends org.opensearch.action.ActionRequest,​ Response extends org.opensearch.action.ActionResponse>
    void    		 doExecute​(org.opensearch.action.ActionType<Response> action, Request request, org.opensearch.action.ActionListener<Response> listener)  
    <Request extends org.opensearch.action.ActionRequest,​ Response extends org.opensearch.action.ActionResponse>
    org.opensearch.tasks.Task    		 executeLocally​(org.opensearch.action.ActionType<Response> action, Request request, org.opensearch.action.ActionListener<Response> listener)  
    <Request extends org.opensearch.action.ActionRequest,​ Response extends org.opensearch.action.ActionResponse>
    org.opensearch.tasks.Task    		 executeLocally​(org.opensearch.action.ActionType<Response> action, Request request, org.opensearch.tasks.TaskListener<Response> listener)  
    java.lang.String getLocalNodeId()  
    org.opensearch.client.Client getRemoteClusterClient​(java.lang.String clusterAlias)  
    void initialize​(java.util.Map<org.opensearch.action.ActionType,​org.opensearch.action.support.TransportAction> actions, java.util.function.Supplier<java.lang.String> localNodeId, org.opensearch.transport.RemoteClusterService remoteClusterService, org.opensearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry)  

    Methods inherited from class org.opensearch.client.node.NodeClient

    getNamedWriteableRegistry

    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

  • Method Details

    • doExecute

      public <Request extends org.opensearch.action.ActionRequest,​ Response extends org.opensearch.action.ActionResponse> void doExecute​(org.opensearch.action.ActionType<Response> action, Request request, org.opensearch.action.ActionListener<Response> listener)
      Overrides:
      doExecute in class org.opensearch.client.node.NodeClient

    • initialize

      public void initialize​(java.util.Map<org.opensearch.action.ActionType,​org.opensearch.action.support.TransportAction> actions, java.util.function.Supplier<java.lang.String> localNodeId, org.opensearch.transport.RemoteClusterService remoteClusterService, org.opensearch.common.io.stream.NamedWriteableRegistry namedWriteableRegistry)
      Overrides:
      initialize in class org.opensearch.client.node.NodeClient

    • executeLocally

      public <Request extends org.opensearch.action.ActionRequest,​ Response extends org.opensearch.action.ActionResponse> org.opensearch.tasks.Task executeLocally​(org.opensearch.action.ActionType<Response> action, Request request, org.opensearch.action.ActionListener<Response> listener)
      Overrides:
      executeLocally in class org.opensearch.client.node.NodeClient

    • executeLocally

      public <Request extends org.opensearch.action.ActionRequest,​ Response extends org.opensearch.action.ActionResponse> org.opensearch.tasks.Task executeLocally​(org.opensearch.action.ActionType<Response> action, Request request, org.opensearch.tasks.TaskListener<Response> listener)
      Overrides:
      executeLocally in class org.opensearch.client.node.NodeClient

    • getLocalNodeId

      public java.lang.String getLocalNodeId()
      Overrides:
      getLocalNodeId in class org.opensearch.client.node.NodeClient

    • getRemoteClusterClient

      public org.opensearch.client.Client getRemoteClusterClient​(java.lang.String clusterAlias)
      Specified by:
      getRemoteClusterClient in interface org.opensearch.client.Client
      Overrides:
      getRemoteClusterClient in class org.opensearch.client.node.NodeClient

    • close

      public void close()
      Specified by:
      close in interface java.lang.AutoCloseable
      Specified by:
      close in interface java.io.Closeable
      Specified by:
      close in interface org.opensearch.common.lease.Releasable
      Overrides:
      close in class org.opensearch.client.node.NodeClient