Get Datafeed Stats API

The Get Datafeed Stats API provides the ability to get any number of machine learning datafeed’s statistics in the cluster. It accepts a GetDatafeedStatsRequest object and responds with a GetDatafeedStatsResponse object.

Get Datafeed Stats Request

A GetDatafeedStatsRequest object can have any number of datafeedId entries. However, they all must be non-null. An empty list is the same as requesting statistics for all datafeeds.

GetDatafeedStatsRequest request =
    new GetDatafeedStatsRequest("get-machine-learning-datafeed-stats1-feed", "get-machine-learning-datafeed*"); 
request.setAllowNoDatafeeds(true); 

Constructing a new request referencing existing datafeedIds, can contain wildcards

Whether to ignore if a wildcard expression matches no datafeeds. (This includes _all string or when no datafeeds have been specified)

Synchronous Execution

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

GetDatafeedStatsResponse response = client.machineLearning().getDatafeedStats(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 GetDatafeedStatsRequest 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-datafeed-stats method:

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

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

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

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

Called when the execution is successfully completed.

Called when the whole GetDatafeedStatsRequest fails.

Get Datafeed Stats Response

The returned GetDatafeedStatsResponse contains the requested datafeed statistics:

long numberOfDatafeedStats = response.count(); 
List<DatafeedStats> datafeedStats = response.datafeedStats(); 

count() indicates the number of datafeeds statistics found

datafeedStats() is the collection of machine learning DatafeedStats objects found