Update filters APIedit

Updates an existing machine learning filter in the cluster. The API accepts a UpdateFilterRequest object as a request and returns a PutFilterResponse.

Update filters requestedit

A UpdateFilterRequest requires the following argument:

UpdateFilterRequest request = new UpdateFilterRequest(filterId); 

The id of the existing machine learning filter.

Optional argumentsedit

The following arguments are optional:

request.setDescription("my new description"); 

The updated description of the machine learning filter.

request.setAddItems(Arrays.asList("*.bing.com", "*.elastic.co")); 

The list of items to add to the machine learning filter.


The list of items to remove from the machine learning filter.

Synchronous executionedit

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

PutFilterResponse response = client.machineLearning().updateFilter(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 UpdateFilterRequest 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 update-filter method:

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

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

ActionListener<PutFilterResponse> listener = new ActionListener<PutFilterResponse>() {
    public void onResponse(PutFilterResponse putFilterResponse) {

    public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole UpdateFilterRequest fails.


The returned PutFilterResponse returns the full representation of the updated machine learning filter if it has been successfully updated.

MlFilter updatedFilter = response.getResponse(); 

The updated MlFilter.