mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-03-03 17:39:15 +00:00
99fef2490a
This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
24 lines
923 B
Plaintext
24 lines
923 B
Plaintext
[[java-rest-high]]
|
|
== Java High Level REST Client
|
|
|
|
The Java High Level REST Client works on top of the Java Low Level REST client.
|
|
Its main goal is to expose API specific methods, that accept request objects as
|
|
an argument and return response objects, so that request marshalling and
|
|
response un-marshalling is handled by the client itself.
|
|
|
|
Each API can be called synchronously or asynchronously. The synchronous
|
|
methods return a response object, while the asynchronous methods, whose names
|
|
end with the `async` suffix, require a listener argument that is notified
|
|
(on the thread pool managed by the low level client) once a response or an
|
|
error is received.
|
|
|
|
The Java High Level REST Client depends on the Elasticsearch core project.
|
|
It accepts the same request arguments as the `TransportClient` and returns
|
|
the same response objects.
|
|
|
|
include::usage.asciidoc[]
|
|
|
|
include::apis.asciidoc[]
|
|
|
|
include::apis/index.asciidoc[]
|