Files
elasticsearch-js/docs/reference/api/RollupStopJobRequest.md
2025-05-27 15:30:21 -05:00

1.1 KiB

Interface RollupStopJobRequest

Name Type Description
body string ({ [key: string]: any; } & { id?: never; timeout?: never; wait_for_completion?: never; })
id Id Identifier for the rollup job.
querystring { [key: string]: any; } & { id?: never; timeout?: never; wait_for_completion?: never; } All values in querystring will be added to the request querystring.
timeout Duration If wait_for_completion is true, the API blocks for (at maximum) the specified duration while waiting for the job to stop. If more than timeout time has passed, the API throws a timeout exception. NOTE: Even if a timeout occurs, the stop request is still processing and eventually moves the job to STOPPED. The timeout simply means the API call itself timed out while waiting for the status change.
wait_for_completion boolean If set to true, causes the API to block until the indexer state completely stops. If set to false, the API returns immediately and the indexer is stopped asynchronously in the background.