New

The executive guide to generative AI

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

Get API

edit

Get API

edit

Get Request

edit

A GetRequest requires the following arguments:

GetRequest getRequest = new GetRequest(
        "posts", 
        "doc",  
        "1");

Index

Type

Document id

Optional arguments

edit

The following arguments can optionally be provided:

request.fetchSourceContext(FetchSourceContext.DO_NOT_FETCH_SOURCE);

Disable source retrieval, enabled by default

 
String[] includes = new String[]{"message", "*Date"};
String[] excludes = Strings.EMPTY_ARRAY;
FetchSourceContext fetchSourceContext =
        new FetchSourceContext(true, includes, excludes);
request.fetchSourceContext(fetchSourceContext);

Configure source inclusion for specific fields

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

Configure source exclusion for specific fields

 
request.storedFields("message"); 
GetResponse getResponse = client.get(request, RequestOptions.DEFAULT);
String message = getResponse.getField("message").getValue();

Configure retrieval for specific stored fields (requires fields to be stored separately in the mappings)

Retrieve the message stored field (requires the field to be stored separately in the mappings)

 
request.routing("routing");

Routing value

 
request.parent("parent");

Parent value

 
request.preference("preference");

Preference value

 
request.realtime(false);

Set realtime flag to false (true by default)

 
request.refresh(true);

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

 
request.version(2);

Version

 
request.versionType(VersionType.EXTERNAL);

Version type

Synchronous Execution

edit
GetResponse getResponse = client.get(getRequest, RequestOptions.DEFAULT);

Asynchronous Execution

edit

The asynchronous execution of a get request requires both the GetRequest instance and an ActionListener instance to be passed to the asynchronous method:

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

The GetRequest 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 GetResponse looks like:

ActionListener<GetResponse> listener = new ActionListener<GetResponse>() {
    @Override
    public void onResponse(GetResponse getResponse) {
        
    }

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

Called when the execution is successfully completed. The response is provided as an argument.

Called in case of failure. The raised exception is provided as an argument.

Get Response

edit

The returned GetResponse allows to retrieve the requested document along with its metadata and eventually stored fields.

String index = getResponse.getIndex();
String type = getResponse.getType();
String id = getResponse.getId();
if (getResponse.isExists()) {
    long version = getResponse.getVersion();
    String sourceAsString = getResponse.getSourceAsString();        
    Map<String, Object> sourceAsMap = getResponse.getSourceAsMap(); 
    byte[] sourceAsBytes = getResponse.getSourceAsBytes();          
} else {
    
}

Retrieve the document as a String

Retrieve the document as a Map<String, Object>

Retrieve the document as a byte[]

Handle the scenario where the document was not found. Note that although the returned response has 404 status code, a valid GetResponse is returned rather than an exception thrown. Such response does not hold any source document and its isExists method returns false.

When a get request is performed against an index that does not exist, the response has 404 status code, an ElasticsearchException gets thrown which needs to be handled as follows:

GetRequest request = new GetRequest("does_not_exist", "doc", "1");
try {
    GetResponse getResponse = client.get(request, RequestOptions.DEFAULT);
} catch (ElasticsearchException e) {
    if (e.status() == RestStatus.NOT_FOUND) {
        
    }
}

Handle the exception thrown because the index does not exist

In case a specific document version has been requested, and the existing document has a different version number, a version conflict is raised:

try {
    GetRequest request = new GetRequest("posts", "doc", "1").version(2);
    GetResponse getResponse = client.get(request, RequestOptions.DEFAULT);
} catch (ElasticsearchException exception) {
    if (exception.status() == RestStatus.CONFLICT) {
        
    }
}

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

On this page

Was this helpful?
Feedback