Set upgrade mode API
editSet upgrade mode API
editTemporarily halts all machine learning job and datafeed tasks when enabled=true. Their
reported states remain unchanged. Consequently, when exiting upgrade mode the halted machine learning jobs and
datafeeds will return to their previous state.
It accepts a SetUpgradeModeRequest object and responds with a AcknowledgedResponse object.
When enabled=true, no new jobs can be opened, and no job or datafeed tasks will
be running. Be sure to set enabled=false once upgrade actions are completed.
Set upgrade mode request
editA SetUpgradeModeRequest object gets created setting the desired enabled state.
Set upgrade mode response
editSynchronous execution
editWhen executing a SetUpgradeModeRequest in the following manner, the client waits
for the AcknowledgedResponse to be returned before continuing with code execution:
AcknowledgedResponse acknowledgedResponse = client.machineLearning().setUpgradeMode(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 SetUpgradeModeRequest 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 set-upgrade-mode 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 set-upgrade-mode looks like: