OpenSearch/docs/reference/rollup/apis
Zachary Tong c346a0f027
[Rollup] Add `wait_for_completion` option to StopRollupJob API (#34811)
This adds a `wait_for_completion` flag which allows the user to block 
the Stop API until the task has actually moved to a stopped state, 
instead of returning immediately.  If the flag is set, a `timeout` parameter
can be specified to determine how long (at max) to block the API
call.  If unspecified, the timeout is 30s.

If the timeout is exceeded before the job moves to STOPPED, a
timeout exception is thrown.  Note: this is just signifying that the API
call itself timed out.  The job will remain in STOPPING and evenutally
flip over to STOPPED in the background.

If the user asks the API to block, we move over the the generic
threadpool so that we don't hold up a networking thread.
2018-11-13 16:37:17 -05:00
..
delete-job.asciidoc [Rollup] Job deletion should be invoked on the allocated task (#34574) 2018-10-23 12:23:22 -04:00
get-job.asciidoc Revert "Rollup add default metrics to histo groups (#34534)" (#34815) 2018-10-24 14:25:10 -05:00
put-job.asciidoc Revert "Rollup add default metrics to histo groups (#34534)" (#34815) 2018-10-24 14:25:10 -05:00
rollup-caps.asciidoc Revert "Rollup add default metrics to histo groups (#34534)" (#34815) 2018-10-24 14:25:10 -05:00
rollup-index-caps.asciidoc Revert "Rollup add default metrics to histo groups (#34534)" (#34815) 2018-10-24 14:25:10 -05:00
rollup-job-config.asciidoc [DOCS] Move rollup APIs to docs (#31450) 2018-08-31 10:50:43 -07:00
rollup-search.asciidoc [Rollup] Proactively resolve index patterns in RollupSearch endoint (#34930) 2018-10-30 13:50:50 -04:00
start-job.asciidoc [DOCS] Move rollup APIs to docs (#31450) 2018-08-31 10:50:43 -07:00
stop-job.asciidoc [Rollup] Add `wait_for_completion` option to StopRollupJob API (#34811) 2018-11-13 16:37:17 -05:00