Class Cancellable

java.lang.Object
org.opensearch.client.Cancellable
All Implemented Interfaces:
org.apache.hc.core5.concurrent.Cancellable
public class Cancellable extends Object implements org.apache.hc.core5.concurrent.Cancellable
Represents an operation that can be cancelled. Returned when executing async requests through RestClient.performRequestAsync(Request, ResponseListener), so that the request can be cancelled if needed. Cancelling a request will result in calling Cancellable.cancel() on the underlying request object, which will in turn cancel its corresponding Future. Note that cancelling a request does not automatically translate to aborting its execution on the server side, which needs to be specifically implemented in each API.

  • Method Details

    • cancel

      public boolean cancel()
      Cancels the on-going request that is associated with the current instance of Cancellable.
      Specified by:
      cancel in interface org.apache.hc.core5.concurrent.Cancellable