Class AutoCloseableOpenSearchClient

java.lang.Object
org.opensearch.client.ApiClient<org.opensearch.client.transport.OpenSearchTransport,org.opensearch.client.opensearch.OpenSearchClient>
org.opensearch.client.opensearch.OpenSearchClient
org.opensearch.data.client.osc.AutoCloseableOpenSearchClient
All Implemented Interfaces:
AutoCloseable

public class AutoCloseableOpenSearchClient extends org.opensearch.client.opensearch.OpenSearchClient implements AutoCloseable
Extension of the OpenSearchClient class that implements AutoCloseable. As the underlying RestClient must be closed properly this is handled in the close() method.
Since:
4.4
  • Field Summary

    Fields inherited from class org.opensearch.client.ApiClient

    transport, transportOptions
  • Constructor Summary

    Constructors
    Constructor
    Description
    AutoCloseableOpenSearchClient(org.opensearch.client.transport.OpenSearchTransport transport)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
     
    org.opensearch.client.opensearch.cluster.OpenSearchClusterClient
     

    Methods inherited from class org.opensearch.client.opensearch.OpenSearchClient

    bulk, bulk, bulk, cat, clearScroll, clearScroll, clearScroll, count, count, count, create, create, createPit, createPit, danglingIndices, delete, delete, deleteByQuery, deleteByQuery, deleteByQueryRethrottle, deleteByQueryRethrottle, deletePit, deletePit, deleteScript, deleteScript, exists, exists, existsSource, existsSource, explain, explain, features, fieldCaps, fieldCaps, fieldCaps, generic, get, get, getScript, getScript, getScriptContext, getScriptLanguages, getSource, getSource, index, index, indices, info, ingest, listAllPit, mget, mget, ml, msearch, msearch, msearchTemplate, msearchTemplate, mtermvectors, mtermvectors, mtermvectors, nodes, ping, putScript, putScript, rankEval, rankEval, reindex, reindex, reindex, reindexRethrottle, reindexRethrottle, renderSearchTemplate, renderSearchTemplate, renderSearchTemplate, scriptsPainlessExecute, scriptsPainlessExecute, scroll, scroll, search, search, searchShards, searchShards, searchShards, searchTemplate, searchTemplate, shutdown, snapshot, tasks, termsEnum, termsEnum, termvectors, termvectors, update, update, updateByQuery, updateByQuery, updateByQueryRethrottle, updateByQueryRethrottle, withTransportOptions

    Methods inherited from class org.opensearch.client.ApiClient

    _transport, _transportOptions, getDeserializer

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • AutoCloseableOpenSearchClient

      public AutoCloseableOpenSearchClient(org.opensearch.client.transport.OpenSearchTransport transport)
  • Method Details

    • close

      public void close() throws Exception
      Specified by:
      close in interface AutoCloseable
      Throws:
      Exception
    • cluster

      public org.opensearch.client.opensearch.cluster.OpenSearchClusterClient cluster()
      Overrides:
      cluster in class org.opensearch.client.opensearch.OpenSearchClient