Brief document blurb about RestClient (#107863)

This commit is contained in:
Dianna Hohensee 2024-05-08 13:34:56 -04:00 committed by GitHub
parent 91f9cf7290
commit 87df295817
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 0 deletions

View File

@ -133,6 +133,14 @@ are only used for internode operations/communications.
### Work Queues
### RestClient
The `RestClient` is primarily used in testing, to send requests against cluster nodes in the same format as would users. There
are some uses of `RestClient`, via `RestClientBuilder`, in the production code. For example, remote reindex leverages the
`RestClient` internally as the REST client to the remote elasticsearch cluster, and to take advantage of the compatibility of
`RestClient` requests with much older elasticsearch versions. The `RestClient` is also used externally by the `Java API Client`
to communicate with Elasticsearch.
# Cluster Coordination
(Sketch of important classes? Might inform more sections to add for details.)