Get Datafeed Stats API
editGet Datafeed Stats API
editThe 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
editA 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.
Synchronous Execution
editWhen 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);
Asynchronous Execution
editExecuting 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:
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.
A typical listener for get-datafeed-stats
looks like:
Get Datafeed Stats Response
editThe returned GetDatafeedStatsResponse
contains the requested datafeed statistics: