Delete Datafeed API

Delete Datafeed Request

A DeleteDatafeedRequest object requires a non-null datafeedId and can optionally set force.

DeleteDatafeedRequest deleteDatafeedRequest = new DeleteDatafeedRequest(datafeedId);
deleteDatafeedRequest.setForce(false); 

Use to forcefully delete a started datafeed; this method is quicker than stopping and deleting the datafeed. Defaults to false.

Synchronous Execution

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

AcknowledgedResponse deleteDatafeedResponse = client.machineLearning().deleteDatafeed(
    deleteDatafeedRequest, 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 Execution

Executing a DeleteDatafeedRequest 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-datafeed method:

client.machineLearning().deleteDatafeedAsync(deleteDatafeedRequest, RequestOptions.DEFAULT, listener); 

The DeleteDatafeedRequest 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-datafeed looks like:

ActionListener<AcknowledgedResponse> listener = new ActionListener<AcknowledgedResponse>() {
    @Override
    public void onResponse(AcknowledgedResponse acknowledgedResponse) {
        
    }

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

Called when the execution is successfully completed.

Called when the whole DeleteDatafeedRequest fails.

Delete Datafeed Response

The returned AcknowledgedResponse object indicates the acknowledgement of the request:

boolean isAcknowledged = deleteDatafeedResponse.isAcknowledged(); 

isAcknowledged was the deletion request acknowledged or not