Delete API
editDelete API
editDelete Request
editA DeleteRequest
requires the following arguments:
Optional arguments
editThe following arguments can optionally be provided:
Timeout to wait for primary shard to become available as a |
|
Timeout to wait for primary shard to become available as a |
Synchronous Execution
editDeleteResponse deleteResponse = client.delete(request);
Asynchronous Execution
editThe asynchronous execution of a delete request requires both the DeleteRequest
instance and an ActionListener
instance to be passed to the asynchronous
method:
The asynchronous method does not block and returns immediately. Once it is
completed the ActionListener
is called back using the onResponse
method
if the execution successfully completed or using the onFailure
method if
it failed.
A typical listener for DeleteResponse
looks like:
Delete Response
editThe returned DeleteResponse
allows to retrieve information about the executed
operation as follows:
String index = deleteResponse.getIndex(); String type = deleteResponse.getType(); String id = deleteResponse.getId(); long version = deleteResponse.getVersion(); ReplicationResponse.ShardInfo shardInfo = deleteResponse.getShardInfo(); if (shardInfo.getTotal() != shardInfo.getSuccessful()) { } if (shardInfo.getFailed() > 0) { for (ReplicationResponse.ShardInfo.Failure failure : shardInfo.getFailures()) { String reason = failure.reason(); } }
Handle the situation where number of successful shards is less than total shards |
|
Handle the potential failures |
It is also possible to check whether the document was found or not:
DeleteRequest request = new DeleteRequest("posts", "doc", "does_not_exist"); DeleteResponse deleteResponse = client.delete(request); if (deleteResponse.getResult() == DocWriteResponse.Result.NOT_FOUND) { }
If there is a version conflict, an ElasticsearchException
will
be thrown: