Delete transform APIedit

Deletes an existing transform.

Delete transform requestedit

A DeleteTransformRequest object requires a non-null id.

DeleteTransformRequest request =
        new DeleteTransformRequest("mega-transform"); 

Constructing a new request referencing an existing transform

Sets the optional argument force. When true, the transform is deleted regardless of its current state. The default value is false, meaning that only stopped transforms can be deleted.

Synchronous executionedit

When executing a DeleteTransformRequest in the following manner, the client waits for the AcknowledgedResponse to be returned before continuing with code execution:

AcknowledgedResponse response =
        .deleteTransform(request, RequestOptions.DEFAULT);

Synchronous calls may throw an IOException in case of either failing to parse the REST response in the high-level REST client, the request times out or similar cases where there is no response coming back from the server.

In cases where the server returns a 4xx or 5xx error code, the high-level client tries to parse the response body error details instead and then throws a generic ElasticsearchException and adds the original ResponseException as a suppressed exception to it.

Asynchronous executionedit

Executing a DeleteTransformRequest can also be done in an asynchronous fashion so that the client can return directly. Users need to specify how the response or potential failures will be handled by passing the request and a listener to the asynchronous delete-transform method:

        request, RequestOptions.DEFAULT, listener);  

The DeleteTransformRequest 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. Failure scenarios and expected exceptions are the same as in the synchronous execution case.

A typical listener for delete-transform looks like:

ActionListener<AcknowledgedResponse> listener =
        new ActionListener<AcknowledgedResponse>() {
    public void onResponse(AcknowledgedResponse response) {

    public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole DeleteTransformRequest fails.


The returned AcknowledgedResponse object acknowledges the transform deletion.