NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.
The Delete Forecast API provides the ability to delete a machine learning job’s
forecast in the cluster.
It accepts a
DeleteForecastRequest object and responds
DeleteForecastRequest object gets created with an existing non-null
All other fields are optional for the request.
The following arguments are optional.
Sets the specific forecastIds to delete, can be set to
Set the timeout for the request to respond, default is 30 seconds
AcknowledgedResponse contains an acknowledgement of the forecast(s) deletion
When executing a
DeleteForecastRequest in the following manner, the client waits
AcknowledgedResponse to be returned before continuing with code execution:
AcknowledgedResponse deleteForecastResponse = client.machineLearning().deleteForecast(deleteForecastRequest, 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.
DeleteForecastRequest 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 delete-forecast 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
delete-forecast looks like: