supported-apis.asciidoc 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  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. include::document/index.asciidoc[]
  15. include::document/get.asciidoc[]
  16. include::document/exists.asciidoc[]
  17. include::document/delete.asciidoc[]
  18. include::document/update.asciidoc[]
  19. include::document/bulk.asciidoc[]
  20. include::document/multi-get.asciidoc[]
  21. == Search APIs
  22. The Java High Level REST Client supports the following Search APIs:
  23. * <<java-rest-high-search>>
  24. * <<java-rest-high-search-scroll>>
  25. * <<java-rest-high-clear-scroll>>
  26. * <<java-rest-high-search-template>>
  27. * <<java-rest-high-multi-search-template>>
  28. * <<java-rest-high-multi-search>>
  29. * <<java-rest-high-field-caps>>
  30. * <<java-rest-high-rank-eval>>
  31. * <<java-rest-high-explain>>
  32. include::search/search.asciidoc[]
  33. include::search/scroll.asciidoc[]
  34. include::search/multi-search.asciidoc[]
  35. include::search/search-template.asciidoc[]
  36. include::search/multi-search-template.asciidoc[]
  37. include::search/field-caps.asciidoc[]
  38. include::search/rank-eval.asciidoc[]
  39. include::search/explain.asciidoc[]
  40. == Miscellaneous APIs
  41. The Java High Level REST Client supports the following Miscellaneous APIs:
  42. * <<java-rest-high-main>>
  43. * <<java-rest-high-ping>>
  44. include::miscellaneous/main.asciidoc[]
  45. include::miscellaneous/ping.asciidoc[]
  46. == Indices APIs
  47. The Java High Level REST Client supports the following Indices APIs:
  48. Index Management::
  49. * <<java-rest-high-create-index>>
  50. * <<java-rest-high-delete-index>>
  51. * <<java-rest-high-indices-exists>>
  52. * <<java-rest-high-open-index>>
  53. * <<java-rest-high-close-index>>
  54. * <<java-rest-high-shrink-index>>
  55. * <<java-rest-high-split-index>>
  56. * <<java-rest-high-refresh>>
  57. * <<java-rest-high-flush>>
  58. * <<java-rest-high-flush-synced>>
  59. * <<java-rest-high-clear-cache>>
  60. * <<java-rest-high-force-merge>>
  61. * <<java-rest-high-rollover-index>>
  62. * <<java-rest-high-indices-put-settings>>
  63. * <<java-rest-high-get-settings>>
  64. * <<java-rest-high-indices-validate-query>>
  65. Mapping Management::
  66. * <<java-rest-high-put-mapping>>
  67. * <<java-rest-high-get-field-mappings>>
  68. Alias Management::
  69. * <<java-rest-high-update-aliases>>
  70. * <<java-rest-high-exists-alias>>
  71. * <<java-rest-high-get-alias>>
  72. include::indices/create_index.asciidoc[]
  73. include::indices/delete_index.asciidoc[]
  74. include::indices/indices_exists.asciidoc[]
  75. include::indices/open_index.asciidoc[]
  76. include::indices/close_index.asciidoc[]
  77. include::indices/shrink_index.asciidoc[]
  78. include::indices/split_index.asciidoc[]
  79. include::indices/refresh.asciidoc[]
  80. include::indices/flush.asciidoc[]
  81. include::indices/flush_synced.asciidoc[]
  82. include::indices/clear_cache.asciidoc[]
  83. include::indices/force_merge.asciidoc[]
  84. include::indices/rollover.asciidoc[]
  85. include::indices/put_mapping.asciidoc[]
  86. include::indices/get_mappings.asciidoc[]
  87. include::indices/get_field_mappings.asciidoc[]
  88. include::indices/update_aliases.asciidoc[]
  89. include::indices/exists_alias.asciidoc[]
  90. include::indices/get_alias.asciidoc[]
  91. include::indices/put_settings.asciidoc[]
  92. include::indices/get_settings.asciidoc[]
  93. include::indices/put_template.asciidoc[]
  94. include::indices/validate_query.asciidoc[]
  95. include::indices/get_templates.asciidoc[]
  96. == Cluster APIs
  97. The Java High Level REST Client supports the following Cluster APIs:
  98. * <<java-rest-high-cluster-put-settings>>
  99. * <<java-rest-high-cluster-get-settings>>
  100. * <<java-rest-high-cluster-health>>
  101. include::cluster/put_settings.asciidoc[]
  102. include::cluster/get_settings.asciidoc[]
  103. include::cluster/health.asciidoc[]
  104. == Ingest APIs
  105. The Java High Level REST Client supports the following Ingest APIs:
  106. * <<java-rest-high-ingest-put-pipeline>>
  107. * <<java-rest-high-ingest-get-pipeline>>
  108. * <<java-rest-high-ingest-delete-pipeline>>
  109. * <<java-rest-high-ingest-simulate-pipeline>>
  110. include::ingest/put_pipeline.asciidoc[]
  111. include::ingest/get_pipeline.asciidoc[]
  112. include::ingest/delete_pipeline.asciidoc[]
  113. include::ingest/simulate_pipeline.asciidoc[]
  114. == Snapshot APIs
  115. The Java High Level REST Client supports the following Snapshot APIs:
  116. * <<java-rest-high-snapshot-get-repository>>
  117. * <<java-rest-high-snapshot-create-repository>>
  118. * <<java-rest-high-snapshot-delete-repository>>
  119. * <<java-rest-high-snapshot-verify-repository>>
  120. * <<java-rest-high-snapshot-create-snapshot>>
  121. * <<java-rest-high-snapshot-get-snapshots>>
  122. * <<java-rest-high-snapshot-delete-snapshot>>
  123. include::snapshot/get_repository.asciidoc[]
  124. include::snapshot/create_repository.asciidoc[]
  125. include::snapshot/delete_repository.asciidoc[]
  126. include::snapshot/verify_repository.asciidoc[]
  127. include::snapshot/create_snapshot.asciidoc[]
  128. include::snapshot/get_snapshots.asciidoc[]
  129. include::snapshot/delete_snapshot.asciidoc[]
  130. == Tasks APIs
  131. The Java High Level REST Client supports the following Tasks APIs:
  132. * <<java-rest-high-tasks-list>>
  133. * <<java-rest-high-cluster-cancel-tasks>>
  134. include::tasks/list_tasks.asciidoc[]
  135. include::tasks/cancel_tasks.asciidoc[]
  136. == Script APIs
  137. The Java High Level REST Client supports the following Scripts APIs:
  138. * <<java-rest-high-get-stored-script>>
  139. * <<java-rest-high-delete-stored-script>>
  140. include::script/get_script.asciidoc[]
  141. include::script/delete_script.asciidoc[]