supported-apis.asciidoc 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  1. [[java-rest-high-supported-apis]]
  2. == Document APIs
  3. The Java High Level REST Client supports the following Document APIs:
  4. [[single-doc]]
  5. Single document APIs::
  6. * <<java-rest-high-document-index>>
  7. * <<java-rest-high-document-get>>
  8. * <<java-rest-high-document-delete>>
  9. * <<java-rest-high-document-update>>
  10. [[multi-doc]]
  11. Multi-document APIs::
  12. * <<java-rest-high-document-bulk>>
  13. * <<java-rest-high-document-multi-get>>
  14. * <<java-rest-high-document-reindex>>
  15. * <<java-rest-high-document-update-by-query>>
  16. * <<java-rest-high-document-delete-by-query>>
  17. include::document/index.asciidoc[]
  18. include::document/get.asciidoc[]
  19. include::document/exists.asciidoc[]
  20. include::document/delete.asciidoc[]
  21. include::document/update.asciidoc[]
  22. include::document/bulk.asciidoc[]
  23. include::document/multi-get.asciidoc[]
  24. include::document/reindex.asciidoc[]
  25. include::document/update-by-query.asciidoc[]
  26. include::document/delete-by-query.asciidoc[]
  27. == Search APIs
  28. The Java High Level REST Client supports the following Search APIs:
  29. * <<java-rest-high-search>>
  30. * <<java-rest-high-search-scroll>>
  31. * <<java-rest-high-clear-scroll>>
  32. * <<java-rest-high-search-template>>
  33. * <<java-rest-high-multi-search-template>>
  34. * <<java-rest-high-multi-search>>
  35. * <<java-rest-high-field-caps>>
  36. * <<java-rest-high-rank-eval>>
  37. * <<java-rest-high-explain>>
  38. include::search/search.asciidoc[]
  39. include::search/scroll.asciidoc[]
  40. include::search/multi-search.asciidoc[]
  41. include::search/search-template.asciidoc[]
  42. include::search/multi-search-template.asciidoc[]
  43. include::search/field-caps.asciidoc[]
  44. include::search/rank-eval.asciidoc[]
  45. include::search/explain.asciidoc[]
  46. == Miscellaneous APIs
  47. The Java High Level REST Client supports the following Miscellaneous APIs:
  48. * <<java-rest-high-main>>
  49. * <<java-rest-high-ping>>
  50. * <<java-rest-high-x-pack-info>>
  51. * <<java-rest-high-x-pack-usage>>
  52. include::miscellaneous/main.asciidoc[]
  53. include::miscellaneous/ping.asciidoc[]
  54. include::miscellaneous/x-pack-info.asciidoc[]
  55. include::miscellaneous/x-pack-usage.asciidoc[]
  56. == Indices APIs
  57. The Java High Level REST Client supports the following Indices APIs:
  58. Index Management::
  59. * <<java-rest-high-create-index>>
  60. * <<java-rest-high-delete-index>>
  61. * <<java-rest-high-indices-exists>>
  62. * <<java-rest-high-open-index>>
  63. * <<java-rest-high-close-index>>
  64. * <<java-rest-high-shrink-index>>
  65. * <<java-rest-high-split-index>>
  66. * <<java-rest-high-refresh>>
  67. * <<java-rest-high-flush>>
  68. * <<java-rest-high-flush-synced>>
  69. * <<java-rest-high-clear-cache>>
  70. * <<java-rest-high-force-merge>>
  71. * <<java-rest-high-rollover-index>>
  72. * <<java-rest-high-indices-put-settings>>
  73. * <<java-rest-high-get-settings>>
  74. * <<java-rest-high-indices-validate-query>>
  75. * <<java-rest-high-get-index>>
  76. Mapping Management::
  77. * <<java-rest-high-put-mapping>>
  78. * <<java-rest-high-get-mappings>>
  79. * <<java-rest-high-get-field-mappings>>
  80. Alias Management::
  81. * <<java-rest-high-update-aliases>>
  82. * <<java-rest-high-exists-alias>>
  83. * <<java-rest-high-get-alias>>
  84. include::indices/analyze.asciidoc[]
  85. include::indices/create_index.asciidoc[]
  86. include::indices/delete_index.asciidoc[]
  87. include::indices/indices_exists.asciidoc[]
  88. include::indices/open_index.asciidoc[]
  89. include::indices/close_index.asciidoc[]
  90. include::indices/shrink_index.asciidoc[]
  91. include::indices/split_index.asciidoc[]
  92. include::indices/refresh.asciidoc[]
  93. include::indices/flush.asciidoc[]
  94. include::indices/flush_synced.asciidoc[]
  95. include::indices/clear_cache.asciidoc[]
  96. include::indices/force_merge.asciidoc[]
  97. include::indices/rollover.asciidoc[]
  98. include::indices/put_mapping.asciidoc[]
  99. include::indices/get_mappings.asciidoc[]
  100. include::indices/get_field_mappings.asciidoc[]
  101. include::indices/update_aliases.asciidoc[]
  102. include::indices/exists_alias.asciidoc[]
  103. include::indices/get_alias.asciidoc[]
  104. include::indices/put_settings.asciidoc[]
  105. include::indices/get_settings.asciidoc[]
  106. include::indices/put_template.asciidoc[]
  107. include::indices/validate_query.asciidoc[]
  108. include::indices/get_templates.asciidoc[]
  109. include::indices/get_index.asciidoc[]
  110. == Cluster APIs
  111. The Java High Level REST Client supports the following Cluster APIs:
  112. * <<java-rest-high-cluster-put-settings>>
  113. * <<java-rest-high-cluster-get-settings>>
  114. * <<java-rest-high-cluster-health>>
  115. include::cluster/put_settings.asciidoc[]
  116. include::cluster/get_settings.asciidoc[]
  117. include::cluster/health.asciidoc[]
  118. == Ingest APIs
  119. The Java High Level REST Client supports the following Ingest APIs:
  120. * <<java-rest-high-ingest-put-pipeline>>
  121. * <<java-rest-high-ingest-get-pipeline>>
  122. * <<java-rest-high-ingest-delete-pipeline>>
  123. * <<java-rest-high-ingest-simulate-pipeline>>
  124. include::ingest/put_pipeline.asciidoc[]
  125. include::ingest/get_pipeline.asciidoc[]
  126. include::ingest/delete_pipeline.asciidoc[]
  127. include::ingest/simulate_pipeline.asciidoc[]
  128. == Snapshot APIs
  129. The Java High Level REST Client supports the following Snapshot APIs:
  130. * <<java-rest-high-snapshot-get-repository>>
  131. * <<java-rest-high-snapshot-create-repository>>
  132. * <<java-rest-high-snapshot-delete-repository>>
  133. * <<java-rest-high-snapshot-verify-repository>>
  134. * <<java-rest-high-snapshot-create-snapshot>>
  135. * <<java-rest-high-snapshot-get-snapshots>>
  136. * <<java-rest-high-snapshot-snapshots-status>>
  137. * <<java-rest-high-snapshot-delete-snapshot>>
  138. include::snapshot/get_repository.asciidoc[]
  139. include::snapshot/create_repository.asciidoc[]
  140. include::snapshot/delete_repository.asciidoc[]
  141. include::snapshot/verify_repository.asciidoc[]
  142. include::snapshot/create_snapshot.asciidoc[]
  143. include::snapshot/get_snapshots.asciidoc[]
  144. include::snapshot/snapshots_status.asciidoc[]
  145. include::snapshot/delete_snapshot.asciidoc[]
  146. == Tasks APIs
  147. The Java High Level REST Client supports the following Tasks APIs:
  148. * <<java-rest-high-tasks-list>>
  149. * <<java-rest-high-cluster-cancel-tasks>>
  150. include::tasks/list_tasks.asciidoc[]
  151. include::tasks/cancel_tasks.asciidoc[]
  152. == Script APIs
  153. The Java High Level REST Client supports the following Scripts APIs:
  154. * <<java-rest-high-get-stored-script>>
  155. * <<java-rest-high-put-stored-script>>
  156. * <<java-rest-high-delete-stored-script>>
  157. include::script/get_script.asciidoc[]
  158. include::script/put_script.asciidoc[]
  159. include::script/delete_script.asciidoc[]
  160. == Licensing APIs
  161. The Java High Level REST Client supports the following Licensing APIs:
  162. * <<java-rest-high-put-license>>
  163. * <<java-rest-high-get-license>>
  164. * <<java-rest-high-delete-license>>
  165. include::licensing/put-license.asciidoc[]
  166. include::licensing/get-license.asciidoc[]
  167. include::licensing/delete-license.asciidoc[]
  168. == Machine Learning APIs
  169. The Java High Level REST Client supports the following Machine Learning APIs:
  170. * <<java-rest-high-x-pack-ml-put-job>>
  171. * <<java-rest-high-x-pack-ml-get-job>>
  172. * <<java-rest-high-x-pack-ml-delete-job>>
  173. * <<java-rest-high-x-pack-ml-open-job>>
  174. * <<java-rest-high-x-pack-ml-close-job>>
  175. * <<java-rest-high-x-pack-ml-flush-job>>
  176. * <<java-rest-high-x-pack-ml-update-job>>
  177. * <<java-rest-high-x-pack-ml-get-job-stats>>
  178. * <<java-rest-high-x-pack-ml-forecast-job>>
  179. * <<java-rest-high-x-pack-ml-get-buckets>>
  180. * <<java-rest-high-x-pack-ml-get-overall-buckets>>
  181. * <<java-rest-high-x-pack-ml-get-records>>
  182. * <<java-rest-high-x-pack-ml-post-data>>
  183. * <<java-rest-high-x-pack-ml-get-influencers>>
  184. include::ml/put-job.asciidoc[]
  185. include::ml/get-job.asciidoc[]
  186. include::ml/delete-job.asciidoc[]
  187. include::ml/open-job.asciidoc[]
  188. include::ml/close-job.asciidoc[]
  189. include::ml/update-job.asciidoc[]
  190. include::ml/flush-job.asciidoc[]
  191. include::ml/get-job-stats.asciidoc[]
  192. include::ml/forecast-job.asciidoc[]
  193. include::ml/get-buckets.asciidoc[]
  194. include::ml/get-overall-buckets.asciidoc[]
  195. include::ml/get-records.asciidoc[]
  196. include::ml/post-data.asciidoc[]
  197. include::ml/get-influencers.asciidoc[]
  198. == Migration APIs
  199. The Java High Level REST Client supports the following Migration APIs:
  200. * <<java-rest-high-migration-get-assistance>>
  201. include::migration/get-assistance.asciidoc[]
  202. == Security APIs
  203. The Java High Level REST Client supports the following Security APIs:
  204. * <<java-rest-high-security-put-user>>
  205. * <<java-rest-high-security-enable-user>>
  206. * <<java-rest-high-security-disable-user>>
  207. include::security/put-user.asciidoc[]
  208. include::security/enable-user.asciidoc[]
  209. include::security/disable-user.asciidoc[]
  210. == Watcher APIs
  211. The Java High Level REST Client supports the following Watcher APIs:
  212. * <<java-rest-high-x-pack-watcher-put-watch>>
  213. * <<java-rest-high-x-pack-watcher-delete-watch>>
  214. include::watcher/put-watch.asciidoc[]
  215. include::watcher/delete-watch.asciidoc[]
  216. == Graph APIs
  217. The Java High Level REST Client supports the following Graph APIs:
  218. * <<java-rest-high-x-pack-graph-explore>>
  219. include::graph/explore.asciidoc[]