New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Get Pipeline API Simulate Pipeline API »
Elastic Docs ›Java REST Client [6.4] ›Java High Level REST Client ›Ingest APIs

Delete Pipeline API

edit

Delete Pipeline API

edit

Delete Pipeline Request

edit

A DeletePipelineRequest requires a pipeline id to delete.

DeletePipelineRequest request = new DeletePipelineRequest("my-pipeline-id");

The pipeline id to delete

Optional arguments

edit

The following arguments can optionally be provided:

request.timeout(TimeValue.timeValueMinutes(2)); 
request.timeout("2m");

Timeout to wait for the all the nodes to acknowledge the pipeline deletion as a TimeValue

Timeout to wait for the all the nodes to acknowledge the pipeline deletion as a String

 
request.masterNodeTimeout(TimeValue.timeValueMinutes(1)); 
request.masterNodeTimeout("1m");

Timeout to connect to the master node as a TimeValue

Timeout to connect to the master node as a String

Synchronous Execution

edit
WritePipelineResponse response = client.ingest().deletePipeline(request, RequestOptions.DEFAULT);

Execute the request and get back the response in a WritePipelineResponse object.

Asynchronous Execution

edit

The asynchronous execution of a delete pipeline request requires both the DeletePipelineRequest instance and an ActionListener instance to be passed to the asynchronous method:

client.ingest().deletePipelineAsync(request, RequestOptions.DEFAULT, listener);

The DeletePipelineRequest to execute and the ActionListener to use when the execution completes

The asynchronous method does not block and returns immediately. Once it is completed the ActionListener is called back using the onResponse method if the execution successfully completed or using the onFailure method if it failed.

A typical listener for WritePipelineResponse looks like:

ActionListener<WritePipelineResponse> listener =
    new ActionListener<WritePipelineResponse>() {
        @Override
        public void onResponse(WritePipelineResponse response) {
            
        }

        @Override
        public void onFailure(Exception e) {
            
        }
    };

Called when the execution is successfully completed. The response is provided as an argument

Called in case of failure. The raised exception is provided as an argument

Delete Pipeline Response

edit

The returned WritePipelineResponse allows to retrieve information about the executed operation as follows:

boolean acknowledged = response.isAcknowledged();

Indicates whether all of the nodes have acknowledged the request
« Get Pipeline API Simulate Pipeline API »