Package org.opensearch.client

Class SearchPipelineClient

java.lang.Object
org.opensearch.client.SearchPipelineClient
public final class SearchPipelineClient extends Object

  • Method Summary

    Modifier and Type
    Method
    Description
    org.opensearch.action.support.master.AcknowledgedResponse
    delete(org.opensearch.action.search.DeleteSearchPipelineRequest request, org.opensearch.client.RequestOptions options)
    Delete an existing pipeline.
    org.opensearch.client.Cancellable
    deleteAsync(org.opensearch.action.search.DeleteSearchPipelineRequest request, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
    Asynchronously delete an existing pipeline.
    org.opensearch.action.search.GetSearchPipelineResponse
    get(org.opensearch.action.search.GetSearchPipelineRequest request, org.opensearch.client.RequestOptions options)
    Get existing pipelines.
    org.opensearch.client.Cancellable
    getAsync(org.opensearch.action.search.GetSearchPipelineRequest request, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.search.GetSearchPipelineResponse> listener)
    Asynchronously get existing pipelines.
    org.opensearch.action.support.master.AcknowledgedResponse
    put(org.opensearch.action.search.PutSearchPipelineRequest request, org.opensearch.client.RequestOptions options)
    Add a pipeline or update an existing pipeline.
    org.opensearch.client.Cancellable
    putAsync(org.opensearch.action.search.PutSearchPipelineRequest request, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
    Asynchronously add a pipeline or update an existing pipeline.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • put

      public org.opensearch.action.support.master.AcknowledgedResponse put(org.opensearch.action.search.PutSearchPipelineRequest request, org.opensearch.client.RequestOptions options) throws IOException
      Add a pipeline or update an existing pipeline.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • putAsync

      public org.opensearch.client.Cancellable putAsync(org.opensearch.action.search.PutSearchPipelineRequest request, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
      Asynchronously add a pipeline or update an existing pipeline.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • get

      public org.opensearch.action.search.GetSearchPipelineResponse get(org.opensearch.action.search.GetSearchPipelineRequest request, org.opensearch.client.RequestOptions options) throws IOException
      Get existing pipelines.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • getAsync

      public org.opensearch.client.Cancellable getAsync(org.opensearch.action.search.GetSearchPipelineRequest request, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.search.GetSearchPipelineResponse> listener)
      Asynchronously get existing pipelines.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • delete

      public org.opensearch.action.support.master.AcknowledgedResponse delete(org.opensearch.action.search.DeleteSearchPipelineRequest request, org.opensearch.client.RequestOptions options) throws IOException
      Delete an existing pipeline.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • deleteAsync

      public org.opensearch.client.Cancellable deleteAsync(org.opensearch.action.search.DeleteSearchPipelineRequest request, org.opensearch.client.RequestOptions options, org.opensearch.core.action.ActionListener<org.opensearch.action.support.master.AcknowledgedResponse> listener)
      Asynchronously delete an existing pipeline.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request