supported-apis.asciidoc 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664
  1. [[java-rest-high-supported-apis]]
  2. == Document APIs
  3. :upid: {mainid}-document
  4. :doc-tests-file: {doc-tests}/CRUDDocumentationIT.java
  5. The Java High Level REST Client supports the following Document APIs:
  6. [[single-doc]]
  7. Single document APIs::
  8. * <<{upid}-index>>
  9. * <<{upid}-get>>
  10. * <<{upid}-exists>>
  11. * <<{upid}-delete>>
  12. * <<{upid}-update>>
  13. * <<{upid}-term-vectors>>
  14. [[multi-doc]]
  15. Multi-document APIs::
  16. * <<{upid}-bulk>>
  17. * <<{upid}-multi-get>>
  18. * <<{upid}-reindex>>
  19. * <<{upid}-update-by-query>>
  20. * <<{upid}-delete-by-query>>
  21. * <<{upid}-rethrottle>>
  22. * <<{upid}-multi-term-vectors>>
  23. include::document/index.asciidoc[]
  24. include::document/get.asciidoc[]
  25. include::document/exists.asciidoc[]
  26. include::document/delete.asciidoc[]
  27. include::document/update.asciidoc[]
  28. include::document/term-vectors.asciidoc[]
  29. include::document/bulk.asciidoc[]
  30. include::document/multi-get.asciidoc[]
  31. include::document/reindex.asciidoc[]
  32. include::document/update-by-query.asciidoc[]
  33. include::document/delete-by-query.asciidoc[]
  34. include::document/rethrottle.asciidoc[]
  35. include::document/multi-term-vectors.asciidoc[]
  36. == Search APIs
  37. :upid: {mainid}
  38. :doc-tests-file: {doc-tests}/SearchDocumentationIT.java
  39. The Java High Level REST Client supports the following Search APIs:
  40. * <<{upid}-search>>
  41. * <<{upid}-search-scroll>>
  42. * <<{upid}-clear-scroll>>
  43. * <<{upid}-search-template>>
  44. * <<{upid}-multi-search-template>>
  45. * <<{upid}-multi-search>>
  46. * <<{upid}-field-caps>>
  47. * <<{upid}-rank-eval>>
  48. * <<{upid}-explain>>
  49. * <<{upid}-count>>
  50. include::search/search.asciidoc[]
  51. include::search/scroll.asciidoc[]
  52. include::search/multi-search.asciidoc[]
  53. include::search/search-template.asciidoc[]
  54. include::search/multi-search-template.asciidoc[]
  55. include::search/field-caps.asciidoc[]
  56. include::search/rank-eval.asciidoc[]
  57. include::search/explain.asciidoc[]
  58. include::search/count.asciidoc[]
  59. == Miscellaneous APIs
  60. The Java High Level REST Client supports the following Miscellaneous APIs:
  61. * <<java-rest-high-main>>
  62. * <<java-rest-high-ping>>
  63. * <<java-rest-high-x-pack-info>>
  64. * <<java-rest-high-x-pack-usage>>
  65. include::miscellaneous/main.asciidoc[]
  66. include::miscellaneous/ping.asciidoc[]
  67. include::miscellaneous/x-pack-info.asciidoc[]
  68. include::miscellaneous/x-pack-usage.asciidoc[]
  69. == Index APIs
  70. :upid: {mainid}
  71. :doc-tests-file: {doc-tests}/IndicesClientDocumentationIT.java
  72. The Java High Level REST Client supports the following Index APIs:
  73. Index Management::
  74. * <<{upid}-analyze>>
  75. * <<{upid}-create-index>>
  76. * <<{upid}-delete-index>>
  77. * <<{upid}-indices-exists>>
  78. * <<{upid}-open-index>>
  79. * <<{upid}-close-index>>
  80. * <<{upid}-shrink-index>>
  81. * <<{upid}-split-index>>
  82. * <<{upid}-clone-index>>
  83. * <<{upid}-refresh>>
  84. * <<{upid}-flush>>
  85. * <<{upid}-flush-synced>>
  86. * <<{upid}-clear-cache>>
  87. * <<{upid}-force-merge>>
  88. * <<{upid}-rollover-index>>
  89. * <<{upid}-indices-put-settings>>
  90. * <<{upid}-get-settings>>
  91. * <<{upid}-indices-validate-query>>
  92. * <<{upid}-get-index>>
  93. Mapping Management::
  94. * <<{upid}-put-mapping>>
  95. * <<{upid}-get-mappings>>
  96. * <<{upid}-get-field-mappings>>
  97. Alias Management::
  98. * <<{upid}-update-aliases>>
  99. * <<{upid}-exists-alias>>
  100. * <<{upid}-get-alias>>
  101. * <<{upid}-delete-alias>>
  102. Template Management::
  103. * <<{upid}-get-templates>>
  104. * <<{upid}-templates-exist>>
  105. * <<{upid}-put-template>>
  106. include::indices/analyze.asciidoc[]
  107. include::indices/create_index.asciidoc[]
  108. include::indices/delete_index.asciidoc[]
  109. include::indices/indices_exists.asciidoc[]
  110. include::indices/open_index.asciidoc[]
  111. include::indices/close_index.asciidoc[]
  112. include::indices/shrink_index.asciidoc[]
  113. include::indices/split_index.asciidoc[]
  114. include::indices/clone_index.asciidoc[]
  115. include::indices/refresh.asciidoc[]
  116. include::indices/flush.asciidoc[]
  117. include::indices/flush_synced.asciidoc[]
  118. include::indices/clear_cache.asciidoc[]
  119. include::indices/force_merge.asciidoc[]
  120. include::indices/rollover.asciidoc[]
  121. include::indices/put_mapping.asciidoc[]
  122. include::indices/get_mappings.asciidoc[]
  123. include::indices/get_field_mappings.asciidoc[]
  124. include::indices/update_aliases.asciidoc[]
  125. include::indices/delete_alias.asciidoc[]
  126. include::indices/exists_alias.asciidoc[]
  127. include::indices/get_alias.asciidoc[]
  128. include::indices/put_settings.asciidoc[]
  129. include::indices/get_settings.asciidoc[]
  130. include::indices/put_template.asciidoc[]
  131. include::indices/validate_query.asciidoc[]
  132. include::indices/get_templates.asciidoc[]
  133. include::indices/templates_exist.asciidoc[]
  134. include::indices/get_index.asciidoc[]
  135. include::indices/freeze_index.asciidoc[]
  136. include::indices/unfreeze_index.asciidoc[]
  137. include::indices/delete_template.asciidoc[]
  138. include::indices/reload_analyzers.asciidoc[]
  139. == Cluster APIs
  140. The Java High Level REST Client supports the following Cluster APIs:
  141. * <<java-rest-high-cluster-put-settings>>
  142. * <<java-rest-high-cluster-get-settings>>
  143. * <<java-rest-high-cluster-health>>
  144. :upid: {mainid}-cluster
  145. :doc-tests-file: {doc-tests}/ClusterClientDocumentationIT.java
  146. include::cluster/put_settings.asciidoc[]
  147. include::cluster/get_settings.asciidoc[]
  148. include::cluster/health.asciidoc[]
  149. == Ingest APIs
  150. The Java High Level REST Client supports the following Ingest APIs:
  151. * <<java-rest-high-ingest-put-pipeline>>
  152. * <<java-rest-high-ingest-get-pipeline>>
  153. * <<java-rest-high-ingest-delete-pipeline>>
  154. * <<java-rest-high-ingest-simulate-pipeline>>
  155. include::ingest/put_pipeline.asciidoc[]
  156. include::ingest/get_pipeline.asciidoc[]
  157. include::ingest/delete_pipeline.asciidoc[]
  158. include::ingest/simulate_pipeline.asciidoc[]
  159. == Snapshot APIs
  160. The Java High Level REST Client supports the following Snapshot APIs:
  161. * <<java-rest-high-snapshot-get-repository>>
  162. * <<java-rest-high-snapshot-create-repository>>
  163. * <<java-rest-high-snapshot-delete-repository>>
  164. * <<java-rest-high-snapshot-verify-repository>>
  165. * <<java-rest-high-snapshot-create-snapshot>>
  166. * <<java-rest-high-snapshot-get-snapshots>>
  167. * <<java-rest-high-snapshot-snapshots-status>>
  168. * <<java-rest-high-snapshot-delete-snapshot>>
  169. * <<java-rest-high-snapshot-restore-snapshot>>
  170. include::snapshot/get_repository.asciidoc[]
  171. include::snapshot/create_repository.asciidoc[]
  172. include::snapshot/delete_repository.asciidoc[]
  173. include::snapshot/verify_repository.asciidoc[]
  174. include::snapshot/create_snapshot.asciidoc[]
  175. include::snapshot/get_snapshots.asciidoc[]
  176. include::snapshot/snapshots_status.asciidoc[]
  177. include::snapshot/delete_snapshot.asciidoc[]
  178. include::snapshot/restore_snapshot.asciidoc[]
  179. == Tasks APIs
  180. The Java High Level REST Client supports the following Tasks APIs:
  181. * <<java-rest-high-tasks-list>>
  182. * <<java-rest-high-cluster-cancel-tasks>>
  183. include::tasks/list_tasks.asciidoc[]
  184. include::tasks/cancel_tasks.asciidoc[]
  185. == Script APIs
  186. The Java High Level REST Client supports the following Scripts APIs:
  187. * <<java-rest-high-get-stored-script>>
  188. * <<java-rest-high-put-stored-script>>
  189. * <<java-rest-high-delete-stored-script>>
  190. include::script/get_script.asciidoc[]
  191. include::script/put_script.asciidoc[]
  192. include::script/delete_script.asciidoc[]
  193. == Licensing APIs
  194. The Java High Level REST Client supports the following Licensing APIs:
  195. * <<java-rest-high-put-license>>
  196. * <<java-rest-high-get-license>>
  197. * <<java-rest-high-delete-license>>
  198. * <<java-rest-high-start-trial>>
  199. * <<java-rest-high-start-basic>>
  200. * <<java-rest-high-get-trial-status>>
  201. * <<java-rest-high-get-basic-status>>
  202. include::licensing/put-license.asciidoc[]
  203. include::licensing/get-license.asciidoc[]
  204. include::licensing/delete-license.asciidoc[]
  205. include::licensing/start-trial.asciidoc[]
  206. include::licensing/start-basic.asciidoc[]
  207. include::licensing/get-trial-status.asciidoc[]
  208. include::licensing/get-basic-status.asciidoc[]
  209. [role="xpack"]
  210. == Machine Learning APIs
  211. :upid: {mainid}-x-pack-ml
  212. :doc-tests-file: {doc-tests}/MlClientDocumentationIT.java
  213. The Java High Level REST Client supports the following Machine Learning APIs:
  214. * <<{upid}-put-job>>
  215. * <<{upid}-get-job>>
  216. * <<{upid}-delete-job>>
  217. * <<{upid}-open-job>>
  218. * <<{upid}-close-job>>
  219. * <<{upid}-flush-job>>
  220. * <<{upid}-update-job>>
  221. * <<{upid}-get-job-stats>>
  222. * <<{upid}-put-datafeed>>
  223. * <<{upid}-update-datafeed>>
  224. * <<{upid}-get-datafeed>>
  225. * <<{upid}-delete-datafeed>>
  226. * <<{upid}-preview-datafeed>>
  227. * <<{upid}-start-datafeed>>
  228. * <<{upid}-stop-datafeed>>
  229. * <<{upid}-get-datafeed-stats>>
  230. * <<{upid}-forecast-job>>
  231. * <<{upid}-delete-forecast>>
  232. * <<{upid}-get-buckets>>
  233. * <<{upid}-get-overall-buckets>>
  234. * <<{upid}-get-records>>
  235. * <<{upid}-post-data>>
  236. * <<{upid}-get-influencers>>
  237. * <<{upid}-get-categories>>
  238. * <<{upid}-get-calendars>>
  239. * <<{upid}-put-calendar>>
  240. * <<{upid}-get-calendar-events>>
  241. * <<{upid}-post-calendar-event>>
  242. * <<{upid}-delete-calendar-event>>
  243. * <<{upid}-put-calendar-job>>
  244. * <<{upid}-delete-calendar-job>>
  245. * <<{upid}-delete-calendar>>
  246. * <<{upid}-get-data-frame-analytics>>
  247. * <<{upid}-get-data-frame-analytics-stats>>
  248. * <<{upid}-put-data-frame-analytics>>
  249. * <<{upid}-delete-data-frame-analytics>>
  250. * <<{upid}-start-data-frame-analytics>>
  251. * <<{upid}-stop-data-frame-analytics>>
  252. * <<{upid}-evaluate-data-frame>>
  253. * <<{upid}-explain-data-frame-analytics>>
  254. * <<{upid}-get-trained-models>>
  255. * <<{upid}-delete-trained-model>>
  256. * <<{upid}-put-filter>>
  257. * <<{upid}-get-filters>>
  258. * <<{upid}-update-filter>>
  259. * <<{upid}-delete-filter>>
  260. * <<{upid}-get-model-snapshots>>
  261. * <<{upid}-delete-model-snapshot>>
  262. * <<{upid}-revert-model-snapshot>>
  263. * <<{upid}-update-model-snapshot>>
  264. * <<{upid}-get-ml-info>>
  265. * <<{upid}-delete-expired-data>>
  266. * <<{upid}-set-upgrade-mode>>
  267. include::ml/put-job.asciidoc[]
  268. include::ml/get-job.asciidoc[]
  269. include::ml/delete-job.asciidoc[]
  270. include::ml/open-job.asciidoc[]
  271. include::ml/close-job.asciidoc[]
  272. include::ml/update-job.asciidoc[]
  273. include::ml/flush-job.asciidoc[]
  274. include::ml/put-datafeed.asciidoc[]
  275. include::ml/update-datafeed.asciidoc[]
  276. include::ml/get-datafeed.asciidoc[]
  277. include::ml/delete-datafeed.asciidoc[]
  278. include::ml/preview-datafeed.asciidoc[]
  279. include::ml/start-datafeed.asciidoc[]
  280. include::ml/stop-datafeed.asciidoc[]
  281. include::ml/get-datafeed-stats.asciidoc[]
  282. include::ml/get-job-stats.asciidoc[]
  283. include::ml/forecast-job.asciidoc[]
  284. include::ml/delete-forecast.asciidoc[]
  285. include::ml/get-buckets.asciidoc[]
  286. include::ml/get-overall-buckets.asciidoc[]
  287. include::ml/get-records.asciidoc[]
  288. include::ml/post-data.asciidoc[]
  289. include::ml/get-influencers.asciidoc[]
  290. include::ml/get-categories.asciidoc[]
  291. include::ml/get-calendars.asciidoc[]
  292. include::ml/put-calendar.asciidoc[]
  293. include::ml/get-calendar-events.asciidoc[]
  294. include::ml/post-calendar-event.asciidoc[]
  295. include::ml/delete-calendar-event.asciidoc[]
  296. include::ml/put-calendar-job.asciidoc[]
  297. include::ml/delete-calendar-job.asciidoc[]
  298. include::ml/delete-calendar.asciidoc[]
  299. include::ml/get-data-frame-analytics.asciidoc[]
  300. include::ml/get-data-frame-analytics-stats.asciidoc[]
  301. include::ml/put-data-frame-analytics.asciidoc[]
  302. include::ml/delete-data-frame-analytics.asciidoc[]
  303. include::ml/start-data-frame-analytics.asciidoc[]
  304. include::ml/stop-data-frame-analytics.asciidoc[]
  305. include::ml/evaluate-data-frame.asciidoc[]
  306. include::ml/explain-data-frame-analytics.asciidoc[]
  307. include::ml/get-trained-models.asciidoc[]
  308. include::ml/delete-trained-model.asciidoc[]
  309. include::ml/put-filter.asciidoc[]
  310. include::ml/get-filters.asciidoc[]
  311. include::ml/update-filter.asciidoc[]
  312. include::ml/delete-filter.asciidoc[]
  313. include::ml/get-model-snapshots.asciidoc[]
  314. include::ml/delete-model-snapshot.asciidoc[]
  315. include::ml/revert-model-snapshot.asciidoc[]
  316. include::ml/update-model-snapshot.asciidoc[]
  317. include::ml/get-info.asciidoc[]
  318. include::ml/delete-expired-data.asciidoc[]
  319. include::ml/set-upgrade-mode.asciidoc[]
  320. == Migration APIs
  321. :upid: {mainid}-migration
  322. :doc-tests-file: {doc-tests}/MigrationClientDocumentationIT.java
  323. The Java High Level REST Client supports the following Migration APIs:
  324. * <<{upid}-get-deprecation-info>>
  325. include::migration/get-deprecation-info.asciidoc[]
  326. [role="xpack"]
  327. == Rollup APIs
  328. :upid: {mainid}-rollup
  329. :doc-tests-file: {doc-tests}/RollupDocumentationIT.java
  330. The Java High Level REST Client supports the following Rollup APIs:
  331. * <<java-rest-high-x-pack-rollup-put-job>>
  332. * <<{upid}-rollup-start-job>>
  333. * <<{upid}-rollup-stop-job>>
  334. * <<{upid}-rollup-delete-job>>
  335. * <<java-rest-high-x-pack-rollup-get-job>>
  336. * <<{upid}-search>>
  337. * <<{upid}-x-pack-rollup-get-rollup-caps>>
  338. * <<{upid}-x-pack-rollup-get-rollup-index-caps>>
  339. include::rollup/put_job.asciidoc[]
  340. include::rollup/start_job.asciidoc[]
  341. include::rollup/stop_job.asciidoc[]
  342. include::rollup/delete_job.asciidoc[]
  343. include::rollup/get_job.asciidoc[]
  344. include::rollup/search.asciidoc[]
  345. include::rollup/get_rollup_caps.asciidoc[]
  346. include::rollup/get_rollup_index_caps.asciidoc[]
  347. [role="xpack"]
  348. == Security APIs
  349. :upid: {mainid}-security
  350. :doc-tests-file: {doc-tests}/SecurityDocumentationIT.java
  351. The Java High Level REST Client supports the following Security APIs:
  352. * <<java-rest-high-security-put-user>>
  353. * <<{upid}-get-users>>
  354. * <<{upid}-delete-user>>
  355. * <<java-rest-high-security-enable-user>>
  356. * <<java-rest-high-security-disable-user>>
  357. * <<java-rest-high-security-change-password>>
  358. * <<{upid}-put-role>>
  359. * <<{upid}-get-roles>>
  360. * <<java-rest-high-security-delete-role>>
  361. * <<{upid}-clear-roles-cache>>
  362. * <<{upid}-clear-realm-cache>>
  363. * <<{upid}-authenticate>>
  364. * <<{upid}-has-privileges>>
  365. * <<{upid}-get-user-privileges>>
  366. * <<java-rest-high-security-get-certificates>>
  367. * <<java-rest-high-security-put-role-mapping>>
  368. * <<java-rest-high-security-get-role-mappings>>
  369. * <<java-rest-high-security-delete-role-mapping>>
  370. * <<java-rest-high-security-create-token>>
  371. * <<{upid}-invalidate-token>>
  372. * <<{upid}-get-builtin-privileges>>
  373. * <<{upid}-get-privileges>>
  374. * <<{upid}-put-privileges>>
  375. * <<{upid}-delete-privileges>>
  376. * <<{upid}-create-api-key>>
  377. * <<{upid}-get-api-key>>
  378. * <<{upid}-invalidate-api-key>>
  379. include::security/put-user.asciidoc[]
  380. include::security/get-users.asciidoc[]
  381. include::security/delete-user.asciidoc[]
  382. include::security/enable-user.asciidoc[]
  383. include::security/disable-user.asciidoc[]
  384. include::security/change-password.asciidoc[]
  385. include::security/put-role.asciidoc[]
  386. include::security/get-roles.asciidoc[]
  387. include::security/delete-role.asciidoc[]
  388. include::security/delete-privileges.asciidoc[]
  389. include::security/get-builtin-privileges.asciidoc[]
  390. include::security/get-privileges.asciidoc[]
  391. include::security/clear-roles-cache.asciidoc[]
  392. include::security/clear-realm-cache.asciidoc[]
  393. include::security/authenticate.asciidoc[]
  394. include::security/has-privileges.asciidoc[]
  395. include::security/get-user-privileges.asciidoc[]
  396. include::security/get-certificates.asciidoc[]
  397. include::security/put-role-mapping.asciidoc[]
  398. include::security/get-role-mappings.asciidoc[]
  399. include::security/delete-role-mapping.asciidoc[]
  400. include::security/create-token.asciidoc[]
  401. include::security/invalidate-token.asciidoc[]
  402. include::security/put-privileges.asciidoc[]
  403. include::security/create-api-key.asciidoc[]
  404. include::security/get-api-key.asciidoc[]
  405. include::security/invalidate-api-key.asciidoc[]
  406. [role="xpack"]
  407. == Watcher APIs
  408. :upid: {mainid}-watcher
  409. :doc-tests-file: {doc-tests}/WatcherDocumentationIT.java
  410. The Java High Level REST Client supports the following Watcher APIs:
  411. * <<{upid}-start-watch-service>>
  412. * <<{upid}-stop-watch-service>>
  413. * <<java-rest-high-x-pack-watcher-put-watch>>
  414. * <<{upid}-get-watch>>
  415. * <<java-rest-high-x-pack-watcher-delete-watch>>
  416. * <<java-rest-high-watcher-deactivate-watch>>
  417. * <<{upid}-ack-watch>>
  418. * <<{upid}-activate-watch>>
  419. * <<{upid}-execute-watch>>
  420. * <<{upid}-watcher-stats>>
  421. include::watcher/start-watch-service.asciidoc[]
  422. include::watcher/stop-watch-service.asciidoc[]
  423. include::watcher/put-watch.asciidoc[]
  424. include::watcher/get-watch.asciidoc[]
  425. include::watcher/delete-watch.asciidoc[]
  426. include::watcher/ack-watch.asciidoc[]
  427. include::watcher/deactivate-watch.asciidoc[]
  428. include::watcher/activate-watch.asciidoc[]
  429. include::watcher/execute-watch.asciidoc[]
  430. include::watcher/watcher-stats.asciidoc[]
  431. [role="xpack"]
  432. == Graph APIs
  433. The Java High Level REST Client supports the following Graph APIs:
  434. * <<java-rest-high-x-pack-graph-explore>>
  435. include::graph/explore.asciidoc[]
  436. ////
  437. Clear attributes that we use to document that APIs included above so they
  438. don't leak into the rest of the documentation.
  439. ////
  440. --
  441. :api!:
  442. :request!:
  443. :response!:
  444. :doc-tests-file!:
  445. :upid!:
  446. --
  447. [role="xpack"]
  448. == CCR APIs
  449. :upid: {mainid}-ccr
  450. :doc-tests-file: {doc-tests}/CCRDocumentationIT.java
  451. The Java High Level REST Client supports the following CCR APIs:
  452. * <<{upid}-ccr-put-follow>>
  453. * <<{upid}-ccr-pause-follow>>
  454. * <<{upid}-ccr-resume-follow>>
  455. * <<{upid}-ccr-unfollow>>
  456. * <<{upid}-ccr-forget-follower>>
  457. * <<{upid}-ccr-put-auto-follow-pattern>>
  458. * <<{upid}-ccr-delete-auto-follow-pattern>>
  459. * <<{upid}-ccr-get-auto-follow-pattern>>
  460. * <<{upid}-ccr-pause-auto-follow-pattern>>
  461. * <<{upid}-ccr-resume-auto-follow-pattern>>
  462. * <<{upid}-ccr-get-stats>>
  463. * <<{upid}-ccr-get-follow-stats>>
  464. * <<{upid}-ccr-get-follow-info>>
  465. include::ccr/put_follow.asciidoc[]
  466. include::ccr/pause_follow.asciidoc[]
  467. include::ccr/resume_follow.asciidoc[]
  468. include::ccr/unfollow.asciidoc[]
  469. include::ccr/forget_follower.asciidoc[]
  470. include::ccr/put_auto_follow_pattern.asciidoc[]
  471. include::ccr/delete_auto_follow_pattern.asciidoc[]
  472. include::ccr/get_auto_follow_pattern.asciidoc[]
  473. include::ccr/pause_auto_follow_pattern.asciidoc[]
  474. include::ccr/resume_auto_follow_pattern.asciidoc[]
  475. include::ccr/get_stats.asciidoc[]
  476. include::ccr/get_follow_stats.asciidoc[]
  477. include::ccr/get_follow_info.asciidoc[]
  478. [role="xpack"]
  479. == Index Lifecycle Management APIs
  480. :upid: {mainid}-ilm
  481. :doc-tests-file: {doc-tests}/ILMDocumentationIT.java
  482. The Java High Level REST Client supports the following Index Lifecycle
  483. Management APIs:
  484. * <<{upid}-ilm-put-lifecycle-policy>>
  485. * <<{upid}-ilm-delete-lifecycle-policy>>
  486. * <<{upid}-ilm-get-lifecycle-policy>>
  487. * <<{upid}-ilm-explain-lifecycle>>
  488. * <<{upid}-ilm-start-ilm>>
  489. * <<{upid}-ilm-stop-ilm>>
  490. * <<{upid}-ilm-status>>
  491. * <<{upid}-ilm-retry-lifecycle-policy>>
  492. * <<{upid}-ilm-remove-lifecycle-policy-from-index>>
  493. include::ilm/put_lifecycle_policy.asciidoc[]
  494. include::ilm/delete_lifecycle_policy.asciidoc[]
  495. include::ilm/get_lifecycle_policy.asciidoc[]
  496. include::ilm/explain_lifecycle.asciidoc[]
  497. include::ilm/start_lifecycle_management.asciidoc[]
  498. include::ilm/stop_lifecycle_management.asciidoc[]
  499. include::ilm/lifecycle_management_status.asciidoc[]
  500. include::ilm/retry_lifecycle_policy.asciidoc[]
  501. include::ilm/remove_lifecycle_policy_from_index.asciidoc[]
  502. [role="xpack"]
  503. == Snapshot Lifecycle Management APIs
  504. :upid: {mainid}-ilm
  505. :doc-tests-file: {doc-tests}/ILMDocumentationIT.java
  506. The Java High Level REST Client supports the following Snapshot Lifecycle
  507. Management APIs:
  508. * <<{upid}-slm-put-snapshot-lifecycle-policy>>
  509. * <<{upid}-slm-delete-snapshot-lifecycle-policy>>
  510. * <<{upid}-ilm-get-lifecycle-policy>>
  511. * <<{upid}-slm-start-slm>>
  512. * <<{upid}-slm-stop-slm>>
  513. * <<{upid}-slm-status>>
  514. * <<{upid}-slm-execute-snapshot-lifecycle-policy>>
  515. * <<{upid}-slm-execute-snapshot-lifecycle-retention>>
  516. include::ilm/put_snapshot_lifecycle_policy.asciidoc[]
  517. include::ilm/delete_snapshot_lifecycle_policy.asciidoc[]
  518. include::ilm/get_snapshot_lifecycle_policy.asciidoc[]
  519. include::ilm/start_snapshot_lifecycle_management.asciidoc[]
  520. include::ilm/stop_snapshot_lifecycle_management.asciidoc[]
  521. include::ilm/snapshot_lifecycle_management_status.asciidoc[]
  522. include::ilm/execute_snapshot_lifecycle_policy.asciidoc[]
  523. include::ilm/execute_snapshot_lifecycle_retention.asciidoc[]
  524. [role="xpack"]
  525. [[transform_apis]]
  526. == {transform-cap} APIs
  527. :upid: {mainid}
  528. :doc-tests-file: {doc-tests}/TransformDocumentationIT.java
  529. The Java High Level REST Client supports the following {transform}
  530. APIs:
  531. * <<{upid}-get-transform>>
  532. * <<{upid}-get-transform-stats>>
  533. * <<{upid}-put-transform>>
  534. * <<{upid}-update-transform>>
  535. * <<{upid}-delete-transform>>
  536. * <<{upid}-preview-transform>>
  537. * <<{upid}-start-transform>>
  538. * <<{upid}-stop-transform>>
  539. include::transform/get_transform.asciidoc[]
  540. include::transform/get_transform_stats.asciidoc[]
  541. include::transform/put_transform.asciidoc[]
  542. include::transform/update_transform.asciidoc[]
  543. include::transform/delete_transform.asciidoc[]
  544. include::transform/preview_transform.asciidoc[]
  545. include::transform/start_transform.asciidoc[]
  546. include::transform/stop_transform.asciidoc[]
  547. == Enrich APIs
  548. :upid: {mainid}-enrich
  549. :doc-tests-file: {doc-tests}/EnrichDocumentationIT.java
  550. The Java High Level REST Client supports the following Enrich APIs:
  551. * <<{upid}-enrich-put-policy>>
  552. * <<{upid}-enrich-delete-policy>>
  553. * <<{upid}-enrich-get-policy>>
  554. * <<{upid}-enrich-stats>>
  555. * <<{upid}-enrich-execute-policy>>
  556. include::enrich/put_policy.asciidoc[]
  557. include::enrich/delete_policy.asciidoc[]
  558. include::enrich/get_policy.asciidoc[]
  559. include::enrich/stats.asciidoc[]
  560. include::enrich/execute_policy.asciidoc[]