Class IngestClient

java.lang.Object
org.elasticsearch.client.IngestClient

public final class IngestClient
extends java.lang.Object
A wrapper for the RestHighLevelClient that provides methods for accessing the Ingest API.

See Ingest API on elastic.co

  • Method Summary

    Modifier and Type Method Description
    org.elasticsearch.action.support.master.AcknowledgedResponse deletePipeline​(org.elasticsearch.action.ingest.DeletePipelineRequest request, org.elasticsearch.client.RequestOptions options)
    Delete an existing pipeline.
    org.elasticsearch.client.Cancellable deletePipelineAsync​(org.elasticsearch.action.ingest.DeletePipelineRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
    Asynchronously delete an existing pipeline.
    org.elasticsearch.action.ingest.GetPipelineResponse getPipeline​(org.elasticsearch.action.ingest.GetPipelineRequest request, org.elasticsearch.client.RequestOptions options)
    Get an existing pipeline.
    org.elasticsearch.client.Cancellable getPipelineAsync​(org.elasticsearch.action.ingest.GetPipelineRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.ingest.GetPipelineResponse> listener)
    Asynchronously get an existing pipeline.
    org.elasticsearch.action.support.master.AcknowledgedResponse putPipeline​(org.elasticsearch.action.ingest.PutPipelineRequest request, org.elasticsearch.client.RequestOptions options)
    Add a pipeline or update an existing pipeline.
    org.elasticsearch.client.Cancellable putPipelineAsync​(org.elasticsearch.action.ingest.PutPipelineRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
    Asynchronously add a pipeline or update an existing pipeline.
    org.elasticsearch.action.ingest.SimulatePipelineResponse simulate​(org.elasticsearch.action.ingest.SimulatePipelineRequest request, org.elasticsearch.client.RequestOptions options)
    Simulate a pipeline on a set of documents provided in the request
    org.elasticsearch.client.Cancellable simulateAsync​(org.elasticsearch.action.ingest.SimulatePipelineRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.ingest.SimulatePipelineResponse> listener)
    Asynchronously simulate a pipeline on a set of documents provided in the request

    Methods inherited from class java.lang.Object

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

    • putPipeline

      public org.elasticsearch.action.support.master.AcknowledgedResponse putPipeline​(org.elasticsearch.action.ingest.PutPipelineRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Add a pipeline or update an existing pipeline. See Put Pipeline API on elastic.co
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      java.io.IOException - in case there is a problem sending the request or parsing back the response
    • putPipelineAsync

      public org.elasticsearch.client.Cancellable putPipelineAsync​(org.elasticsearch.action.ingest.PutPipelineRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
      Asynchronously add a pipeline or update an existing pipeline. See Put Pipeline API on elastic.co
      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
    • getPipeline

      public org.elasticsearch.action.ingest.GetPipelineResponse getPipeline​(org.elasticsearch.action.ingest.GetPipelineRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Get an existing pipeline. See Get Pipeline API on elastic.co
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      java.io.IOException - in case there is a problem sending the request or parsing back the response
    • getPipelineAsync

      public org.elasticsearch.client.Cancellable getPipelineAsync​(org.elasticsearch.action.ingest.GetPipelineRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.ingest.GetPipelineResponse> listener)
      Asynchronously get an existing pipeline. See Get Pipeline API on elastic.co
      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
    • deletePipeline

      public org.elasticsearch.action.support.master.AcknowledgedResponse deletePipeline​(org.elasticsearch.action.ingest.DeletePipelineRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Delete an existing pipeline. See Delete Pipeline API on elastic.co
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      java.io.IOException - in case there is a problem sending the request or parsing back the response
    • deletePipelineAsync

      public org.elasticsearch.client.Cancellable deletePipelineAsync​(org.elasticsearch.action.ingest.DeletePipelineRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
      Asynchronously delete an existing pipeline. See Delete Pipeline API on elastic.co
      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
    • simulate

      public org.elasticsearch.action.ingest.SimulatePipelineResponse simulate​(org.elasticsearch.action.ingest.SimulatePipelineRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Simulate a pipeline on a set of documents provided in the request

      See Simulate Pipeline API on elastic.co

      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      java.io.IOException - in case there is a problem sending the request or parsing back the response
    • simulateAsync

      public org.elasticsearch.client.Cancellable simulateAsync​(org.elasticsearch.action.ingest.SimulatePipelineRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.ingest.SimulatePipelineResponse> listener)
      Asynchronously simulate a pipeline on a set of documents provided in the request

      See Simulate Pipeline API on elastic.co

      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