Package org.elasticsearch.client
Class Cancellable
java.lang.Object
org.elasticsearch.client.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 AbstractExecutionAwareRequest.abort()
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.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract void
cancel()
Cancels the on-going request that is associated with the current instance ofCancellable
.
-
Constructor Details
-
Cancellable
public Cancellable()
-
-
Method Details
-
cancel
public abstract void cancel()Cancels the on-going request that is associated with the current instance ofCancellable
.
-