WARNING: Deprecated in 7.15.0.
The Java REST Client is deprecated in favor of the Java API Client.
Multi Term Vectors API allows to get multiple term vectors at once.
There are two ways to create a
The first way is to create an empty
MultiTermVectorsRequest, and then add individual
term vectors requests to it.
MultiTermVectorsRequest request = new MultiTermVectorsRequest(); TermVectorsRequest tvrequest1 = new TermVectorsRequest("authors", "1"); tvrequest1.setFields("user"); request.add(tvrequest1); XContentBuilder docBuilder = XContentFactory.jsonBuilder(); docBuilder.startObject().field("user", "guest-user").endObject(); TermVectorsRequest tvrequest2 = new TermVectorsRequest("authors", docBuilder); request.add(tvrequest2);
Create an empty
Add the first
Add the second
The second way can be used when all term vectors requests share the same
arguments, such as index and other settings. In this case, a template
TermVectorsRequest can be created with all necessary settings set, and
this template request can be passed to
MultiTermVectorsRequest along with all
documents' ids for which to execute these requests.
When executing a
MultiTermVectorsRequest in the following manner, the client waits
MultiTermVectorsResponse to be returned before continuing with code execution:
MultiTermVectorsResponse response = client.mtermvectors(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
5xx error code, the high-level
client tries to parse the response body error details instead and then throws
ElasticsearchException and adds the original
ResponseException as a
suppressed exception to it.
MultiTermVectorsRequest 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-term-vectors method:
The asynchronous method does not block and returns immediately. Once it is
ActionListener is called back using the
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-term-vectors looks like:
MultiTermVectorsResponse allows to get the list of term vectors responses,
each of which can be inspected as described in
Term Vectors API.