The Forecast Job API provides the ability to forecast a machine learning job’s behavior based
on historical data.
It accepts a
ForecastJobRequest object and responds
ForecastJobRequest object gets created with an existing non-null
All other fields are optional for the request.
The following arguments are optional.
Set when the forecast for the job should expire
Set how far into the future should the forecast predict
Set the maximum amount of memory the forecast is allowed to use. Defaults to 20mb. Maximum is 500mb, minimum is 1mb. If set to 40% or more of the job’s configured memory limit, it is automatically reduced to below that number.
ForecastJobResponse contains an acknowledgement and the forecast ID
When executing a
ForecastJobRequest in the following manner, the client waits
ForecastJobResponse to be returned before continuing with code execution:
ForecastJobResponse forecastJobResponse = client.machineLearning().forecastJob(forecastJobRequest, 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
5xx error code, the high-level
client tries to parse the response body error details instead and then throws
ElasticsearchException and adds the original
ResponseException as a
suppressed exception to it.
ForecastJobRequest 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 forecast-job method:
The asynchronous method does not block and returns immediately. Once it is
ActionListener is called back using the
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
forecast-job looks like: