Get data frame analytics jobs stats API
editGet data frame analytics jobs stats API
editThis functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
Retrieves the operational statistics of one or more data frame analytics jobs.
The API accepts a GetDataFrameAnalyticsStatsRequest
object and returns a GetDataFrameAnalyticsStatsResponse
.
Get data frame analytics jobs stats request
editA GetDataFrameAnalyticsStatsRequest
requires either a data frame analytics job ID, a comma-separated list of
IDs, or the special wildcard _all
to get the statistics for all
data frame analytics jobs.
Synchronous execution
editWhen executing a GetDataFrameAnalyticsStatsRequest
in the following manner, the client waits
for the GetDataFrameAnalyticsStatsResponse
to be returned before continuing with code execution:
GetDataFrameAnalyticsStatsResponse response = client.machineLearning().getDataFrameAnalyticsStats(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 GetDataFrameAnalyticsStatsRequest
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-data-frame-analytics-stats method:
client.machineLearning().getDataFrameAnalyticsStatsAsync(request, RequestOptions.DEFAULT, listener);
The |
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-data-frame-analytics-stats
looks like:
Response
editThe returned GetDataFrameAnalyticsStatsResponse
contains the requested data frame analytics job statistics.
List<DataFrameAnalyticsStats> stats = response.getAnalyticsStats();