OpenSearch/docs/reference/ml/apis
Dimitris Athanasiou 4dacfa95d2
[ML] Allow asynchronous job deletion (#34058)
This changes the delete job API by adding
the choice to delete a job asynchronously.
The commit adds a `wait_for_completion` parameter
to the delete job request. When set to `false`,
the action returns immediately and the response
contains the task id.

This also changes the handling of subsequent
delete requests for a job that is already being
deleted. It now uses the task framework to check
if the job is being deleted instead of the cluster
state. This is a beneficial for it is going to also
be working once the job configs are moved out of the
cluster state and into an index. Also, force delete
requests that are waiting for the job to be deleted
will not proceed with the deletion if the first task
fails. This will prevent overloading the cluster. Instead,
the failure is communicated better via notifications
so that the user may retry.

Finally, this makes the `deleting` property of the job
visible (also it was renamed from `deleted`). This allows
a client to render a deleting job differently.

Closes #32836
2018-10-05 02:41:28 +03:00
..
calendarresource.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
close-job.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
datafeedresource.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
delete-calendar-event.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
delete-calendar-job.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
delete-calendar.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
delete-datafeed.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
delete-filter.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
delete-forecast.asciidoc [DOCS] Adds delete forecast API (#33401) 2018-09-06 09:20:42 -07:00
delete-job.asciidoc [ML] Allow asynchronous job deletion (#34058) 2018-10-05 02:41:28 +03:00
delete-snapshot.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
eventresource.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
filterresource.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
find-file-structure.asciidoc [ML] Fix unit test deadlock problem (#34174) 2018-10-01 15:35:37 +01:00
flush-job.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
forecast.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
get-bucket.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
get-calendar-event.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
get-calendar.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
get-category.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
get-datafeed-stats.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
get-datafeed.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
get-filter.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
get-influencer.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
get-job-stats.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
get-job.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
get-overall-buckets.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
get-record.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
get-snapshot.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
jobcounts.asciidoc Fix a variety of typos and misspelled words (#32792) 2018-10-03 18:11:38 +01:00
jobresource.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
ml-api.asciidoc [DOCS][ML] Document the ML find_file_structure endpoint (#33723) 2018-09-20 12:17:09 +01:00
open-job.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
post-calendar-event.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
post-data.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
preview-datafeed.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
put-calendar-job.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
put-calendar.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
put-datafeed.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
put-filter.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
put-job.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
resultsresource.asciidoc [ML] Label anomalies with multi_bucket_impact (#34233) 2018-10-04 09:08:21 +01:00
revert-snapshot.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
snapshotresource.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
start-datafeed.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
stop-datafeed.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
update-datafeed.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
update-filter.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
update-job.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
update-snapshot.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
validate-detector.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00
validate-job.asciidoc [DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00