IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elastic Docs ›Java REST Client [6.5] ›Java High Level REST Client ›Document APIs
« Exists API Update API »

Delete APIedit

Delete Requestedit

A DeleteRequest has no arguments

DeleteRequest request = new DeleteRequest(
        "posts",    
        "doc",      
        "1");

Index

Type

Document id

Optional argumentsedit

The following arguments can optionally be provided:

request.routing("routing");

Routing value

 
request.parent("parent");

Parent value

 
request.timeout(TimeValue.timeValueMinutes(2)); 
request.timeout("2m");

Timeout to wait for primary shard to become available as a TimeValue

Timeout to wait for primary shard to become available as a String

 
request.setRefreshPolicy(WriteRequest.RefreshPolicy.WAIT_UNTIL); 
request.setRefreshPolicy("wait_for");

Refresh policy as a WriteRequest.RefreshPolicy instance

Refresh policy as a String

 
request.version(2);

Version

 
request.versionType(VersionType.EXTERNAL);

Version type

Synchronous Executionedit

When executing a DeleteRequest in the following manner, the client waits for the DeleteResponse to be returned before continuing with code execution:

DeleteResponse deleteResponse = client.delete(
        request, RequestOptions.DEFAULT);

Asynchronous Executionedit

Executing a DeleteRequest can also be done in an asynchronous fashion so that the client can return directly. Users need to specify how the response or potential failures will be handled by passing the request and a listener to the asynchronous delete method:

client.deleteAsync(request, RequestOptions.DEFAULT, listener);

The DeleteRequest to execute and the ActionListener to use when the execution completes

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 delete looks like:

listener = new ActionListener<DeleteResponse>() {
    @Override
    public void onResponse(DeleteResponse deleteResponse) {
        
    }

    @Override
    public void onFailure(Exception e) {
        
    }
};

Called when the execution is successfully completed.

Called when the whole DeleteRequest fails.

Delete Responseedit

The 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, RequestOptions.DEFAULT);
if (deleteResponse.getResult() == DocWriteResponse.Result.NOT_FOUND) {
    
}

Do something if the document to be deleted was not found

If there is a version conflict, an ElasticsearchException will be thrown:

try {
    DeleteResponse deleteResponse = client.delete(
            new DeleteRequest("posts", "doc", "1").version(2),
            RequestOptions.DEFAULT);
} catch (ElasticsearchException exception) {
    if (exception.status() == RestStatus.CONFLICT) {
        
    }
}

The raised exception indicates that a version conflict error was returned
« Exists API Update API »