Get Filters API

The Get Filters API retrieves one or more filter results. It accepts a GetFiltersRequest object and responds with a GetFiltersResponse object.

Get Filters Request

A GetFiltersRequest object gets created.

GetFiltersRequest request = new GetFiltersRequest(); 

Constructing a new request

Optional Arguments

The following arguments are optional:

request.setFilterId("get-filter-doc-test"); 

The id of the filter to get. Otherwise it will return all filters.

request.setFrom(100); 
request.setSize(200); 

from specifies the number of filters to skip. Defaults to 0.

size specifies the maximum number of filters to get. Defaults to 100.

Synchronous Execution

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

GetFiltersResponse response = client.machineLearning().getFilter(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 GetFiltersRequest 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 get-filters method:

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

The GetFiltersRequest 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 get-filters looks like:

ActionListener<GetFiltersResponse> listener = new ActionListener<GetFiltersResponse>() {
    @Override
    public void onResponse(GetFiltersResponse getfiltersResponse) {
        
    }

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

Called when the execution is successfully completed.

Called when the whole GetFiltersRequest fails.

Get Filters Response

The returned GetFiltersResponse contains the requested filters:

long count = response.count(); 
List<MlFilter> filters = response.filters(); 

The count of filters that were matched

The filters retrieved