mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 04:58:50 +00:00
a086c665a3
Adds support for the Clear Roles Cache API to the High Level Rest Client. As part of this a helper class, NodesResponseHeader, has been added that enables parsing the nodes header from responses that are node requests. Relates to #29827
33 lines
943 B
Plaintext
33 lines
943 B
Plaintext
|
|
--
|
|
:api: clear-roles-cache
|
|
:request: ClearRolesCacheRequest
|
|
:response: ClearRolesCacheResponse
|
|
--
|
|
|
|
[id="{upid}-{api}"]
|
|
=== Clear Roles Cache API
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Clear Roles Cache Request
|
|
|
|
A +{request}+ supports defining the name of roles that the cache should be cleared for.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Clear Roles Cache Response
|
|
|
|
The returned +{response}+ allows to retrieve information about where the cache was cleared.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|
|
<1> the list of nodes that the cache was cleared on
|