OpenSearch/docs/java-rest
Luca Cavanna cfb186afaf Add support for cancelling async requests in low-level REST client (#45379)
The low-level REST client exposes a `performRequestAsync` method that
allows to send async requests, but today it does not expose the ability
to cancel such requests. That is something that the underlying apache
async http client supports, and it makes sense for us to expose.

This commit adds a return value to the `performRequestAsync` method,
which is backwards compatible. A `Cancellable` object gets returned,
which exposes a `cancel` public method. When calling `cancel`, the
on-going request associated with the returned `Cancellable` instance
will be cancelled by calling its `abort` method. This works throughout
multiple retries, though some special care was needed for the case where
`cancel` is called between different attempts (when one attempt has
failed and the consecutive one has not been sent yet).

Note that cancelling a request on the client side does not automatically 
translate to cancelling the server side execution of it. That needs to be 
specifically implemented, which is on the work for the search API (see #43332).

Relates to #44802
2019-09-12 09:45:28 +02:00
..
high-level [DOCS] Adds missing icons to Watcher HLRC APIs (#46626) 2019-09-11 16:35:15 -07:00
low-level Add support for cancelling async requests in low-level REST client (#45379) 2019-09-12 09:45:28 +02:00
index.asciidoc [DOCS] restructure java clients docs pages (#25517) 2017-07-04 10:58:57 +02:00
license.asciidoc [Docs] Update Copyright notices to 2018 (#29404) 2018-04-06 16:21:20 +02:00
overview.asciidoc [DOCS] restructure java clients docs pages (#25517) 2017-07-04 10:58:57 +02:00