Delete anomaly detection job API
editDelete anomaly detection job API
editDeletes an anomaly detection job that exists in the cluster.
Delete anomaly detection job request
editA DeleteJobRequest
object requires a non-null jobId
and can optionally set force
.
Optional arguments
editThe following arguments are optional:
Use to forcefully delete an opened job. This method is quicker than closing
and deleting the job. Defaults to |
Delete anomaly detection job response
editThe returned AcknowledgedResponse
object indicates the acknowledgement of the job
deletion or the deletion task depending on whether the request was set to wait
for completion:
Synchronous execution
editWhen executing a DeleteJobRequest
in the following manner, the client waits
for the AcknowledgedResponse
to be returned before continuing with code execution:
DeleteJobResponse deleteJobResponse = client.machineLearning().deleteJob(deleteJobRequest, 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 DeleteJobRequest
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-job 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 delete-job
looks like: