Get Job Stats API
editGet Job Stats API
editThe Get Job Stats API provides the ability to get any number of
machine learning job’s statistics in the cluster.
It accepts a GetJobStatsRequest
object and responds
with a GetJobStatsResponse
object.
Get Job Stats Request
editA GetJobsStatsRequest
object can have any number of jobId
entries. However, they all must be non-null. An empty list is the same as
requesting statistics for all jobs.
Synchronous Execution
editWhen executing a GetJobStatsRequest
in the following manner, the client waits
for the GetJobStatsResponse
to be returned before continuing with code execution:
GetJobStatsResponse response = client.machineLearning().getJobStats(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
editExecuting a GetJobStatsRequest
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-job-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. Failure scenarios and expected exceptions are the same as in the
synchronous execution case.
A typical listener for get-job-stats
looks like:
Get Job Stats Response
editThe returned GetJobStatsResponse
contains the requested job statistics: