reload_analyzers.asciidoc 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. --
  2. :api: reload-analyzers
  3. :request: ReloadAnalyzersRequest
  4. :response: ReloadAnalyzersResponse
  5. --
  6. [id="{upid}-{api}"]
  7. === Reload Search Analyzers API
  8. [id="{upid}-{api}-request"]
  9. ==== Reload Search Analyzers Request
  10. An +{request}+ requires an `index` argument:
  11. ["source","java",subs="attributes,callouts,macros"]
  12. --------------------------------------------------
  13. include-tagged::{doc-tests-file}[{api}-request]
  14. --------------------------------------------------
  15. <1> The index to reload
  16. ==== Optional arguments
  17. The following arguments can optionally be provided:
  18. ["source","java",subs="attributes,callouts,macros"]
  19. --------------------------------------------------
  20. include-tagged::{doc-tests-file}[{api}-request-indicesOptions]
  21. --------------------------------------------------
  22. <1> Setting `IndicesOptions` controls how unavailable indices are resolved and
  23. how wildcard expressions are expanded
  24. include::../execution.asciidoc[]
  25. [id="{upid}-{api}-response"]
  26. ==== Reload Search Analyzers Response
  27. The returned +{response}+ allows to retrieve information about the
  28. executed operation as follows:
  29. ["source","java",subs="attributes,callouts,macros"]
  30. --------------------------------------------------
  31. include-tagged::{doc-tests-file}[{api}-response]
  32. --------------------------------------------------
  33. <1> Shard statistics. Note that reloading does not happen on each shard of an
  34. index, but once on each node the index has shards on. The reported shard count
  35. can therefore differ from the number of index shards
  36. <2> Reloading details of all indices the request was executed on
  37. <3> Details can be retrieved by index name
  38. <4> The reloaded index name
  39. <5> The nodes the index was reloaded on
  40. <6> The analyzer names that were reloaded