Delete User API

Delete User Request

A user can be deleted as follows:

DeleteUserRequest deleteUserRequest = new DeleteUserRequest(
    "testUser");    

Delete Response

The returned DeleteUserResponse allows to retrieve information about the executed operation as follows:

boolean found = deleteUserResponse.isAcknowledged();    

whether the given user was found

Synchronous Execution

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

DeleteUserResponse deleteUserResponse = client.security().deleteUser(deleteUserRequest, RequestOptions.DEFAULT);

Synchronous calls may throw an IOException in case of either failing to parse the REST response in the high-level REST client, the request times out or similar cases where there is no response coming back from the server.

In cases where the server returns a 4xx or 5xx error code, the high-level client tries to parse the response body error details instead and then throws a generic ElasticsearchException and adds the original ResponseException as a suppressed exception to it.

Asynchronous Execution

Executing a DeleteUserRequest 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-user method:

client.security().deleteUserAsync(deleteUserRequest, RequestOptions.DEFAULT, listener); 

The DeleteUserRequest 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. Failure scenarios and expected exceptions are the same as in the synchronous execution case.

A typical listener for delete-user looks like:

listener = new ActionListener<DeleteUserResponse>() {
    @Override
    public void onResponse(DeleteUserResponse deleteUserResponse) {
        
    }

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

Called when the execution is successfully completed.

Called when the whole DeleteUserRequest fails.