Package org.opensearch.client

Class IngestClient

java.lang.Object

org.opensearch.client.IngestClient

public final class IngestClient
extends java.lang.Object

A wrapper for the RestHighLevelClient that provides methods for accessing the Ingest API.

Method Summary

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

putPipeline

public org.opensearch.action.support.master.AcknowledgedResponse putPipeline(org.opensearch.action.ingest.PutPipelineRequest request,
                                                                             org.opensearch.client.RequestOptions options)
                                                                      throws java.io.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:

java.io.IOException - in case there is a problem sending the request or parsing back the response

putPipelineAsync

public org.opensearch.client.Cancellable putPipelineAsync(org.opensearch.action.ingest.PutPipelineRequest request,
                                                          org.opensearch.client.RequestOptions options,
                                                          org.opensearch.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

getPipeline

public org.opensearch.action.ingest.GetPipelineResponse getPipeline(org.opensearch.action.ingest.GetPipelineRequest request,
                                                                    org.opensearch.client.RequestOptions options)
                                                             throws java.io.IOException

Get 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:

java.io.IOException - in case there is a problem sending the request or parsing back the response

getPipelineAsync

public org.opensearch.client.Cancellable getPipelineAsync(org.opensearch.action.ingest.GetPipelineRequest request,
                                                          org.opensearch.client.RequestOptions options,
                                                          org.opensearch.action.ActionListener<org.opensearch.action.ingest.GetPipelineResponse> listener)

Asynchronously get 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

deletePipeline

public org.opensearch.action.support.master.AcknowledgedResponse deletePipeline(org.opensearch.action.ingest.DeletePipelineRequest request,
                                                                                org.opensearch.client.RequestOptions options)
                                                                         throws java.io.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:

java.io.IOException - in case there is a problem sending the request or parsing back the response

deletePipelineAsync

public org.opensearch.client.Cancellable deletePipelineAsync(org.opensearch.action.ingest.DeletePipelineRequest request,
                                                             org.opensearch.client.RequestOptions options,
                                                             org.opensearch.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

simulate

public org.opensearch.action.ingest.SimulatePipelineResponse simulate(org.opensearch.action.ingest.SimulatePipelineRequest request,
                                                                      org.opensearch.client.RequestOptions options)
                                                               throws java.io.IOException

Simulate a pipeline on a set of documents provided in the request

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.opensearch.client.Cancellable simulateAsync(org.opensearch.action.ingest.SimulatePipelineRequest request,
                                                       org.opensearch.client.RequestOptions options,
                                                       org.opensearch.action.ActionListener<org.opensearch.action.ingest.SimulatePipelineResponse> listener)

Asynchronously simulate a pipeline on a set of documents provided in the request

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