- Java REST Client (deprecated): other versions:
- Overview
- Java High Level REST Client
- Getting started
- Document APIs
- Search APIs
- Async Search APIs
- Miscellaneous APIs
- Index APIs
- Analyze API
- Create Index API
- Delete Index API
- Index Exists API
- Open Index API
- Close Index API
- Shrink Index API
- Split Index API
- Clone Index API
- Refresh API
- Flush API
- Flush Synced API
- Clear Cache API
- Force Merge API
- Rollover Index API
- Update mapping API
- Get Mappings API
- Get Field Mappings API
- Index Aliases API
- Delete Alias API
- Exists Alias API
- Get Alias API
- Update Indices Settings API
- Get Settings API
- Create or update index template API
- Validate Query API
- Get Templates API
- Templates Exist API
- Get Index API
- Freeze Index API
- Unfreeze Index API
- Delete Template API
- Reload Search Analyzers API
- Get Composable Index Templates API
- Create or update composable index template API
- Delete Composable Index Template API
- Optional arguments
- Simulate Index Template API
- Cluster APIs
- Ingest APIs
- Snapshot APIs
- Tasks APIs
- Script APIs
- Licensing APIs
- Machine Learning APIs
- Close anomaly detection jobs API
- Delete anomaly detection jobs API
- Delete anomaly detection jobs from calendar API
- Delete calendar events API
- Delete calendars API
- Delete data frame analytics jobs API
- Delete datafeeds API
- Delete expired data API
- Delete filters API
- Delete forecasts API
- Delete model snapshots API
- Delete trained models API
- Delete trained model alias API
- Estimate anomaly detection job model memory API
- Evaluate data frame analytics API
- Explain data frame analytics API
- Flush jobs API
- Forecast jobs API
- Get anomaly detection jobs API
- Get anomaly detection job stats API
- Get buckets API
- Get calendar events API
- Get calendars API
- Get categories API
- Get data frame analytics jobs API
- Get data frame analytics jobs stats API
- Get datafeeds API
- Get datafeed stats API
- Get filters API
- Get influencers API
- Get machine learning info API
- Get model snapshots API
- Get overall buckets API
- Get records API
- Get trained models API
- Get trained models stats API
- Open anomaly detection jobs API
- Post calendar events API
- Post data API
- Preview datafeeds API
- Create anomaly detection jobs API
- Add anomaly detection jobs to calendar API
- Create calendars API
- Create data frame analytics jobs API
- Create datafeeds API
- Create filters API
- Create trained models API
- Create or update trained model alias API
- Reset anomaly detection jobs API
- Revert model snapshots API
- Set upgrade mode API
- Start data frame analytics jobs API
- Start datafeeds API
- Stop data frame analytics jobs API
- Stop datafeeds API
- Update anomaly detection jobs API
- Update data frame analytics jobs API
- Update datafeeds API
- Update filters API
- Update model snapshots API
- Upgrade job snapshot API
- Migration APIs
- Rollup APIs
- Security APIs
- Create or update user API
- Get Users API
- Delete User API
- Enable User API
- Disable User API
- Change Password API
- Create or update role API
- Get Roles API
- Delete Role API
- Delete Privileges API
- Get Builtin Privileges API
- Get Application Privileges API
- Clear Roles Cache API
- Clear Privileges Cache API
- Clear Realm Cache API
- Clear API Key Cache API
- Clear Service Account Token Cache API
- Authenticate API
- Has Privileges API
- Get User Privileges API
- SSL Certificate API
- Create or update role mapping API
- Get Role Mappings API
- Delete Role Mapping API
- Create Token API
- Invalidate Token API
- Create or update privileges API
- Create API Key API
- Grant API key API
- Get API Key information API
- Invalidate API Key API
- Query API Key information API
- Get Service Accounts API
- Create Service Account Token API
- Delete Service Account Token API
- Get Service Account Credentials API
- Text Structure APIs
- Watcher APIs
- Graph APIs
- CCR APIs
- Index Lifecycle Management APIs
- Snapshot Lifecycle Management APIs
- Create or update snapshot lifecycle policy API
- Delete Snapshot Lifecycle Policy API
- Get Snapshot Lifecycle Policy API
- Start Snapshot Lifecycle Management API
- Stop Snapshot Lifecycle Management API
- Snapshot Lifecycle Management Status API
- Execute Snapshot Lifecycle Policy API
- Execute Snapshot Lifecycle Retention API
- Searchable Snapshots APIs
- Transform APIs
- Enrich APIs
- EQL APIs
- Using Java Builders
- Migration Guide
- License
WARNING: Deprecated in 7.15.0.
The Java REST Client is deprecated in favor of the Java API Client.
Multi-Get API
editMulti-Get API
editThe multiGet
API executes multiple get
requests in a single http request in parallel.
Multi-Get Request
editA MultiGetRequest
is built empty and you add `MultiGetRequest.Item`s to configure
what to fetch:
Optional arguments
editmultiGet
supports the same optional arguments that the
get
API supports.
You can set most of these on the Item
:
request.add(new MultiGetRequest.Item("index", "example_id") .fetchSourceContext(FetchSourceContext.DO_NOT_FETCH_SOURCE));
String[] includes = new String[] {"foo", "*r"}; String[] excludes = Strings.EMPTY_ARRAY; FetchSourceContext fetchSourceContext = new FetchSourceContext(true, includes, excludes); request.add(new MultiGetRequest.Item("index", "example_id") .fetchSourceContext(fetchSourceContext));
String[] includes = Strings.EMPTY_ARRAY; String[] excludes = new String[] {"foo", "*r"}; FetchSourceContext fetchSourceContext = new FetchSourceContext(true, includes, excludes); request.add(new MultiGetRequest.Item("index", "example_id") .fetchSourceContext(fetchSourceContext));
request.add(new MultiGetRequest.Item("index", "example_id") .storedFields("foo")); MultiGetResponse response = client.mget(request, RequestOptions.DEFAULT); MultiGetItemResponse item = response.getResponses()[0]; String value = item.getResponse().getField("foo").getValue();
Configure retrieval for specific stored fields (requires fields to be stored separately in the mappings) |
|
Retrieve the |
request.add(new MultiGetRequest.Item("index", "with_routing") .routing("some_routing")); request.add(new MultiGetRequest.Item("index", "with_version") .versionType(VersionType.EXTERNAL) .version(10123L));
preference
,
realtime
and
refresh
can be set on the main request but
not on any items:
Synchronous execution
editWhen executing a MultiGetRequest
in the following manner, the client waits
for the MultiGetResponse
to be returned before continuing with code execution:
MultiGetResponse response = client.mget(request, 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
editExecuting a MultiGetRequest
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 multi-get 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. Failure scenarios and expected exceptions are the same as in the
synchronous execution case.
A typical listener for multi-get
looks like:
Multi Get Response
editThe returned MultiGetResponse
contains a list of MultiGetItemResponse`s in
`getResponses
in the same order that they were requested.
MultiGetItemResponse
contains either a
GetResponse
if the get succeeded
or a MultiGetResponse.Failure
if it failed. A success looks just like a
normal GetResponse
.
MultiGetItemResponse firstItem = response.getResponses()[0]; assertNull(firstItem.getFailure()); GetResponse firstGet = firstItem.getResponse(); String index = firstItem.getIndex(); String id = firstItem.getId(); if (firstGet.isExists()) { long version = firstGet.getVersion(); String sourceAsString = firstGet.getSourceAsString(); Map<String, Object> sourceAsMap = firstGet.getSourceAsMap(); byte[] sourceAsBytes = firstGet.getSourceAsBytes(); } else { }
|
|
|
|
Retrieve the document as a |
|
Retrieve the document as a |
|
Retrieve the document as a |
|
Handle the scenario where the document was not found. Note that although
the returned response has |
When one of the subrequests as performed against an index that does not exist
getFailure
will contain an exception:
assertNull(missingIndexItem.getResponse()); Exception e = missingIndexItem.getFailure().getFailure(); ElasticsearchException ee = (ElasticsearchException) e; // TODO status is broken! fix in a followup // assertEquals(RestStatus.NOT_FOUND, ee.status()); assertThat(e.getMessage(), containsString("reason=no such index [missing_index]"));
|
|
|
|
That |
|
and it has a status of |
|
|
In case a specific document version has been requested, and the existing document has a different version number, a version conflict is raised:
MultiGetRequest request = new MultiGetRequest(); request.add(new MultiGetRequest.Item("index", "example_id") .version(1000L)); MultiGetResponse response = client.mget(request, RequestOptions.DEFAULT); MultiGetItemResponse item = response.getResponses()[0]; assertNull(item.getResponse()); Exception e = item.getFailure().getFailure(); ElasticsearchException ee = (ElasticsearchException) e; // TODO status is broken! fix in a followup // assertEquals(RestStatus.CONFLICT, ee.status()); assertThat(e.getMessage(), containsString("version conflict, current version [1] is " + "different than the one provided [1000]"));
On this page
ElasticON events are back!
Learn about the Elastic Search AI Platform from the experts at our live events.
Register now