Package org.elasticsearch.client

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
AcknowledgedResponse	deletePipeline(DeletePipelineRequest request, RequestOptions options)	Delete an existing pipeline.
Cancellable	deletePipelineAsync(DeletePipelineRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)	Asynchronously delete an existing pipeline.
GetPipelineResponse	getPipeline(GetPipelineRequest request, RequestOptions options)	Get an existing pipeline.
Cancellable	getPipelineAsync(GetPipelineRequest request, RequestOptions options, ActionListener<GetPipelineResponse> listener)	Asynchronously get an existing pipeline.
AcknowledgedResponse	putPipeline(PutPipelineRequest request, RequestOptions options)	Add a pipeline or update an existing pipeline.
Cancellable	putPipelineAsync(PutPipelineRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)	Asynchronously add a pipeline or update an existing pipeline.
SimulatePipelineResponse	simulate(SimulatePipelineRequest request, RequestOptions options)	Simulate a pipeline on a set of documents provided in the request
Cancellable	simulateAsync(SimulatePipelineRequest request, RequestOptions options, ActionListener<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 Detail

putPipeline

public AcknowledgedResponse putPipeline(PutPipelineRequest request,
                                        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 Cancellable putPipelineAsync(PutPipelineRequest request,
                                    RequestOptions options,
                                    ActionListener<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 GetPipelineResponse getPipeline(GetPipelineRequest request,
                                       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 Cancellable getPipelineAsync(GetPipelineRequest request,
                                    RequestOptions options,
                                    ActionListener<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 AcknowledgedResponse deletePipeline(DeletePipelineRequest request,
                                           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 Cancellable deletePipelineAsync(DeletePipelineRequest request,
                                       RequestOptions options,
                                       ActionListener<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 SimulatePipelineResponse simulate(SimulatePipelineRequest request,
                                         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 Cancellable simulateAsync(SimulatePipelineRequest request,
                                 RequestOptions options,
                                 ActionListener<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