Delete Filter API

Delete a machine learning filter. The API accepts a DeleteFilterRequest and responds with a AcknowledgedResponse object.

Delete Filter Request

A DeleteFilterRequest object requires a non-null filterId.

DeleteFilterRequest request = new DeleteFilterRequest(filterId); 

Constructing a new request referencing an existing filter

Delete Filter Response

The returned AcknowledgedResponse object indicates the acknowledgement of the request:

boolean isAcknowledged = response.isAcknowledged(); 

isAcknowledged was the deletion request acknowledged or not

Synchronous Execution

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

AcknowledgedResponse response = client.machineLearning().deleteFilter(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 Execution

Executing a DeleteFilterRequest 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-filter method:

client.machineLearning().deleteFilterAsync(request, RequestOptions.DEFAULT, listener); 

The DeleteFilterRequest 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-filter looks like:

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

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

Called when the execution is successfully completed.

Called when the whole DeleteFilterRequest fails.