Get Source APIedit

This API helps to get only the _source field of a document.

Get Source Requestedit

A GetSourceRequest requires the following arguments:

GetSourceRequest getSourceRequest = new GetSourceRequest(


Document id

Optional argumentsedit

The following arguments can optionally be provided:

String[] includes = Strings.EMPTY_ARRAY;  
String[] excludes = new String[]{"postDate"};
    new FetchSourceContext(true, includes, excludes)); 

FetchSourceContext 's first argument fetchSource must be true, otherwise ElasticsearchException get thrown

Arguments of the context excludes and includes are optional (see examples in Get API documentation)


Routing value


Preference value


Set realtime flag to false (true by default)


Perform a refresh before retrieving the document (false by default)

Synchronous executionedit

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

GetSourceResponse response =
    client.getSource(getSourceRequest, 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 executionedit

Executing a GetSourceRequest 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 get-source method:

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

The GetSourceRequest 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 get-source looks like:

ActionListener<GetSourceResponse> listener =
    new ActionListener<GetSourceResponse>() {
        public void onResponse(GetSourceResponse getResponse) {

        public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole GetSourceRequest fails.

Get Source Responseedit

The returned GetSourceResponse contains the field source that represents the source of a document as a map.

Map<String, Object> source = response.getSource();