2017-08-01 04:38:56 -04:00
|
|
|
[[java-rest-high-supported-apis]]
|
2017-02-24 07:52:36 -05:00
|
|
|
|
2018-02-02 11:19:50 -05:00
|
|
|
== Document APIs
|
2017-07-03 04:48:16 -04:00
|
|
|
|
2018-10-01 09:59:36 -04:00
|
|
|
:upid: {mainid}-document
|
|
|
|
:doc-tests-file: {doc-tests}/CRUDDocumentationIT.java
|
|
|
|
|
2018-02-02 11:19:50 -05:00
|
|
|
The Java High Level REST Client supports the following Document APIs:
|
2017-10-26 03:52:46 -04:00
|
|
|
|
2018-02-02 11:19:50 -05:00
|
|
|
[[single-doc]]
|
2017-09-06 08:06:41 -04:00
|
|
|
Single document APIs::
|
2018-10-01 09:59:36 -04:00
|
|
|
* <<{upid}-index>>
|
|
|
|
* <<{upid}-get>>
|
2018-10-05 11:41:03 -04:00
|
|
|
* <<{upid}-exists>>
|
2018-10-01 09:59:36 -04:00
|
|
|
* <<{upid}-delete>>
|
|
|
|
* <<{upid}-update>>
|
2018-10-24 14:27:22 -04:00
|
|
|
* <<{upid}-term-vectors>>
|
2017-07-03 04:48:16 -04:00
|
|
|
|
2018-02-02 11:19:50 -05:00
|
|
|
[[multi-doc]]
|
|
|
|
Multi-document APIs::
|
2018-10-01 09:59:36 -04:00
|
|
|
* <<{upid}-bulk>>
|
|
|
|
* <<{upid}-multi-get>>
|
|
|
|
* <<{upid}-reindex>>
|
|
|
|
* <<{upid}-update-by-query>>
|
|
|
|
* <<{upid}-delete-by-query>>
|
2018-10-02 17:13:08 -04:00
|
|
|
* <<{upid}-rethrottle>>
|
2017-07-03 04:48:16 -04:00
|
|
|
|
2018-02-02 11:19:50 -05:00
|
|
|
include::document/index.asciidoc[]
|
|
|
|
include::document/get.asciidoc[]
|
2018-03-15 12:10:30 -04:00
|
|
|
include::document/exists.asciidoc[]
|
2018-02-02 11:19:50 -05:00
|
|
|
include::document/delete.asciidoc[]
|
|
|
|
include::document/update.asciidoc[]
|
2018-10-24 14:27:22 -04:00
|
|
|
include::document/term-vectors.asciidoc[]
|
2018-02-02 11:19:50 -05:00
|
|
|
include::document/bulk.asciidoc[]
|
2018-03-16 18:52:34 -04:00
|
|
|
include::document/multi-get.asciidoc[]
|
2018-08-28 13:02:23 -04:00
|
|
|
include::document/reindex.asciidoc[]
|
2018-09-02 15:15:00 -04:00
|
|
|
include::document/update-by-query.asciidoc[]
|
2018-09-04 08:56:26 -04:00
|
|
|
include::document/delete-by-query.asciidoc[]
|
2018-10-02 15:44:15 -04:00
|
|
|
include::document/rethrottle.asciidoc[]
|
2018-02-02 11:19:50 -05:00
|
|
|
|
|
|
|
== Search APIs
|
|
|
|
|
2018-10-01 09:59:36 -04:00
|
|
|
:upid: {mainid}
|
|
|
|
:doc-tests-file: {doc-tests}/SearchDocumentationIT.java
|
|
|
|
|
2018-02-02 11:19:50 -05:00
|
|
|
The Java High Level REST Client supports the following Search APIs:
|
|
|
|
|
2018-10-01 09:59:36 -04:00
|
|
|
* <<{upid}-search>>
|
|
|
|
* <<{upid}-search-scroll>>
|
|
|
|
* <<{upid}-clear-scroll>>
|
|
|
|
* <<{upid}-search-template>>
|
|
|
|
* <<{upid}-multi-search-template>>
|
|
|
|
* <<{upid}-multi-search>>
|
|
|
|
* <<{upid}-field-caps>>
|
|
|
|
* <<{upid}-rank-eval>>
|
|
|
|
* <<{upid}-explain>>
|
2017-08-01 04:38:56 -04:00
|
|
|
|
2018-02-02 11:19:50 -05:00
|
|
|
include::search/search.asciidoc[]
|
|
|
|
include::search/scroll.asciidoc[]
|
2018-03-23 10:11:50 -04:00
|
|
|
include::search/multi-search.asciidoc[]
|
2018-05-15 16:07:58 -04:00
|
|
|
include::search/search-template.asciidoc[]
|
2018-06-28 09:05:26 -04:00
|
|
|
include::search/multi-search-template.asciidoc[]
|
2018-04-26 12:50:37 -04:00
|
|
|
include::search/field-caps.asciidoc[]
|
2018-04-10 04:15:31 -04:00
|
|
|
include::search/rank-eval.asciidoc[]
|
2018-06-27 09:20:56 -04:00
|
|
|
include::search/explain.asciidoc[]
|
2018-02-02 11:19:50 -05:00
|
|
|
|
|
|
|
== Miscellaneous APIs
|
|
|
|
|
|
|
|
The Java High Level REST Client supports the following Miscellaneous APIs:
|
|
|
|
|
2017-08-01 04:38:56 -04:00
|
|
|
* <<java-rest-high-main>>
|
2018-03-14 14:27:01 -04:00
|
|
|
* <<java-rest-high-ping>>
|
2018-07-08 11:03:56 -04:00
|
|
|
* <<java-rest-high-x-pack-info>>
|
2018-08-10 08:12:42 -04:00
|
|
|
* <<java-rest-high-x-pack-usage>>
|
2017-09-06 08:06:41 -04:00
|
|
|
|
2018-02-02 11:19:50 -05:00
|
|
|
include::miscellaneous/main.asciidoc[]
|
2018-03-14 14:27:01 -04:00
|
|
|
include::miscellaneous/ping.asciidoc[]
|
2018-08-10 08:12:42 -04:00
|
|
|
include::miscellaneous/x-pack-info.asciidoc[]
|
|
|
|
include::miscellaneous/x-pack-usage.asciidoc[]
|
2018-02-02 11:19:50 -05:00
|
|
|
|
|
|
|
== Indices APIs
|
|
|
|
|
|
|
|
The Java High Level REST Client supports the following Indices APIs:
|
|
|
|
|
|
|
|
Index Management::
|
|
|
|
* <<java-rest-high-create-index>>
|
|
|
|
* <<java-rest-high-delete-index>>
|
|
|
|
* <<java-rest-high-indices-exists>>
|
|
|
|
* <<java-rest-high-open-index>>
|
|
|
|
* <<java-rest-high-close-index>>
|
|
|
|
* <<java-rest-high-shrink-index>>
|
|
|
|
* <<java-rest-high-split-index>>
|
2018-02-28 05:49:14 -05:00
|
|
|
* <<java-rest-high-refresh>>
|
2018-03-01 04:56:03 -05:00
|
|
|
* <<java-rest-high-flush>>
|
2018-05-30 07:32:52 -04:00
|
|
|
* <<java-rest-high-flush-synced>>
|
2018-03-20 05:39:36 -04:00
|
|
|
* <<java-rest-high-clear-cache>>
|
2018-03-22 12:17:16 -04:00
|
|
|
* <<java-rest-high-force-merge>>
|
2018-02-20 09:58:58 -05:00
|
|
|
* <<java-rest-high-rollover-index>>
|
2018-04-16 15:39:11 -04:00
|
|
|
* <<java-rest-high-indices-put-settings>>
|
2018-05-04 11:14:28 -04:00
|
|
|
* <<java-rest-high-get-settings>>
|
2018-06-18 09:59:29 -04:00
|
|
|
* <<java-rest-high-indices-validate-query>>
|
2018-07-05 13:52:25 -04:00
|
|
|
* <<java-rest-high-get-index>>
|
2018-02-02 11:19:50 -05:00
|
|
|
|
|
|
|
Mapping Management::
|
|
|
|
* <<java-rest-high-put-mapping>>
|
2018-07-03 19:10:52 -04:00
|
|
|
* <<java-rest-high-get-mappings>>
|
2018-06-23 03:39:17 -04:00
|
|
|
* <<java-rest-high-get-field-mappings>>
|
2018-02-02 11:19:50 -05:00
|
|
|
|
|
|
|
Alias Management::
|
|
|
|
* <<java-rest-high-update-aliases>>
|
|
|
|
* <<java-rest-high-exists-alias>>
|
2018-06-12 04:26:17 -04:00
|
|
|
* <<java-rest-high-get-alias>>
|
2018-02-02 11:19:50 -05:00
|
|
|
|
2018-07-03 10:57:02 -04:00
|
|
|
include::indices/analyze.asciidoc[]
|
2018-02-02 11:19:50 -05:00
|
|
|
include::indices/create_index.asciidoc[]
|
|
|
|
include::indices/delete_index.asciidoc[]
|
|
|
|
include::indices/indices_exists.asciidoc[]
|
|
|
|
include::indices/open_index.asciidoc[]
|
|
|
|
include::indices/close_index.asciidoc[]
|
|
|
|
include::indices/shrink_index.asciidoc[]
|
|
|
|
include::indices/split_index.asciidoc[]
|
2018-02-28 05:49:14 -05:00
|
|
|
include::indices/refresh.asciidoc[]
|
2018-03-01 04:56:03 -05:00
|
|
|
include::indices/flush.asciidoc[]
|
2018-05-30 07:32:52 -04:00
|
|
|
include::indices/flush_synced.asciidoc[]
|
2018-03-20 05:39:36 -04:00
|
|
|
include::indices/clear_cache.asciidoc[]
|
2018-03-22 12:17:16 -04:00
|
|
|
include::indices/force_merge.asciidoc[]
|
2018-02-20 09:58:58 -05:00
|
|
|
include::indices/rollover.asciidoc[]
|
2018-02-02 11:19:50 -05:00
|
|
|
include::indices/put_mapping.asciidoc[]
|
2018-06-04 16:31:08 -04:00
|
|
|
include::indices/get_mappings.asciidoc[]
|
2018-06-23 03:39:17 -04:00
|
|
|
include::indices/get_field_mappings.asciidoc[]
|
2018-02-02 11:19:50 -05:00
|
|
|
include::indices/update_aliases.asciidoc[]
|
|
|
|
include::indices/exists_alias.asciidoc[]
|
2018-06-12 04:26:17 -04:00
|
|
|
include::indices/get_alias.asciidoc[]
|
2018-04-16 15:39:11 -04:00
|
|
|
include::indices/put_settings.asciidoc[]
|
2018-05-04 11:14:28 -04:00
|
|
|
include::indices/get_settings.asciidoc[]
|
2018-05-06 09:47:36 -04:00
|
|
|
include::indices/put_template.asciidoc[]
|
2018-06-18 09:59:29 -04:00
|
|
|
include::indices/validate_query.asciidoc[]
|
2018-06-11 11:06:28 -04:00
|
|
|
include::indices/get_templates.asciidoc[]
|
2018-07-05 13:52:25 -04:00
|
|
|
include::indices/get_index.asciidoc[]
|
2018-02-02 11:19:50 -05:00
|
|
|
|
2018-02-15 11:21:45 -05:00
|
|
|
== Cluster APIs
|
|
|
|
|
|
|
|
The Java High Level REST Client supports the following Cluster APIs:
|
|
|
|
|
|
|
|
* <<java-rest-high-cluster-put-settings>>
|
2018-07-02 13:25:17 -04:00
|
|
|
* <<java-rest-high-cluster-get-settings>>
|
2018-06-12 07:34:06 -04:00
|
|
|
* <<java-rest-high-cluster-health>>
|
2018-02-15 11:21:45 -05:00
|
|
|
|
2018-09-28 14:48:11 -04:00
|
|
|
:upid: {mainid}-cluster
|
|
|
|
:doc-tests-file: {doc-tests}/ClusterClientDocumentationIT.java
|
2018-02-15 11:21:45 -05:00
|
|
|
include::cluster/put_settings.asciidoc[]
|
2018-07-02 13:25:17 -04:00
|
|
|
include::cluster/get_settings.asciidoc[]
|
2018-06-12 07:34:06 -04:00
|
|
|
include::cluster/health.asciidoc[]
|
2018-06-04 04:34:55 -04:00
|
|
|
|
|
|
|
== Ingest APIs
|
|
|
|
The Java High Level REST Client supports the following Ingest APIs:
|
|
|
|
|
|
|
|
* <<java-rest-high-ingest-put-pipeline>>
|
|
|
|
* <<java-rest-high-ingest-get-pipeline>>
|
|
|
|
* <<java-rest-high-ingest-delete-pipeline>>
|
2018-06-22 03:59:04 -04:00
|
|
|
* <<java-rest-high-ingest-simulate-pipeline>>
|
2018-06-04 04:34:55 -04:00
|
|
|
|
|
|
|
include::ingest/put_pipeline.asciidoc[]
|
|
|
|
include::ingest/get_pipeline.asciidoc[]
|
|
|
|
include::ingest/delete_pipeline.asciidoc[]
|
2018-06-22 03:59:04 -04:00
|
|
|
include::ingest/simulate_pipeline.asciidoc[]
|
2018-05-09 08:25:23 -04:00
|
|
|
|
|
|
|
== Snapshot APIs
|
|
|
|
|
|
|
|
The Java High Level REST Client supports the following Snapshot APIs:
|
|
|
|
|
|
|
|
* <<java-rest-high-snapshot-get-repository>>
|
2018-05-21 20:52:21 -04:00
|
|
|
* <<java-rest-high-snapshot-create-repository>>
|
|
|
|
* <<java-rest-high-snapshot-delete-repository>>
|
2018-05-30 12:10:00 -04:00
|
|
|
* <<java-rest-high-snapshot-verify-repository>>
|
2018-06-27 12:30:10 -04:00
|
|
|
* <<java-rest-high-snapshot-create-snapshot>>
|
2018-06-27 20:04:34 -04:00
|
|
|
* <<java-rest-high-snapshot-get-snapshots>>
|
2018-07-11 12:07:31 -04:00
|
|
|
* <<java-rest-high-snapshot-snapshots-status>>
|
2018-06-20 10:42:50 -04:00
|
|
|
* <<java-rest-high-snapshot-delete-snapshot>>
|
2018-05-09 08:25:23 -04:00
|
|
|
|
2018-05-15 22:21:11 -04:00
|
|
|
include::snapshot/get_repository.asciidoc[]
|
2018-05-16 07:31:37 -04:00
|
|
|
include::snapshot/create_repository.asciidoc[]
|
2018-05-21 20:52:21 -04:00
|
|
|
include::snapshot/delete_repository.asciidoc[]
|
2018-05-30 12:10:00 -04:00
|
|
|
include::snapshot/verify_repository.asciidoc[]
|
2018-06-27 12:30:10 -04:00
|
|
|
include::snapshot/create_snapshot.asciidoc[]
|
2018-06-27 20:04:34 -04:00
|
|
|
include::snapshot/get_snapshots.asciidoc[]
|
2018-07-11 12:07:31 -04:00
|
|
|
include::snapshot/snapshots_status.asciidoc[]
|
2018-06-20 10:42:50 -04:00
|
|
|
include::snapshot/delete_snapshot.asciidoc[]
|
2018-05-29 04:54:41 -04:00
|
|
|
|
|
|
|
== Tasks APIs
|
|
|
|
|
|
|
|
The Java High Level REST Client supports the following Tasks APIs:
|
|
|
|
|
|
|
|
* <<java-rest-high-tasks-list>>
|
2018-06-07 17:02:23 -04:00
|
|
|
* <<java-rest-high-cluster-cancel-tasks>>
|
2018-05-29 04:54:41 -04:00
|
|
|
|
|
|
|
include::tasks/list_tasks.asciidoc[]
|
2018-06-07 17:02:23 -04:00
|
|
|
include::tasks/cancel_tasks.asciidoc[]
|
2018-06-19 08:21:11 -04:00
|
|
|
|
|
|
|
== Script APIs
|
|
|
|
|
|
|
|
The Java High Level REST Client supports the following Scripts APIs:
|
|
|
|
|
|
|
|
* <<java-rest-high-get-stored-script>>
|
2018-09-09 07:47:47 -04:00
|
|
|
* <<java-rest-high-put-stored-script>>
|
2018-06-19 08:21:11 -04:00
|
|
|
* <<java-rest-high-delete-stored-script>>
|
|
|
|
|
|
|
|
include::script/get_script.asciidoc[]
|
2018-09-09 07:47:47 -04:00
|
|
|
include::script/put_script.asciidoc[]
|
2018-06-19 08:21:11 -04:00
|
|
|
include::script/delete_script.asciidoc[]
|
2018-07-24 14:19:07 -04:00
|
|
|
|
|
|
|
== Licensing APIs
|
|
|
|
|
|
|
|
The Java High Level REST Client supports the following Licensing APIs:
|
|
|
|
|
|
|
|
* <<java-rest-high-put-license>>
|
2018-08-10 04:55:25 -04:00
|
|
|
* <<java-rest-high-get-license>>
|
2018-08-14 05:55:54 -04:00
|
|
|
* <<java-rest-high-delete-license>>
|
2018-10-17 11:02:04 -04:00
|
|
|
* <<java-rest-high-start-trial>>
|
2018-10-16 09:21:30 -04:00
|
|
|
* <<java-rest-high-start-basic>>
|
2018-07-24 14:19:07 -04:00
|
|
|
|
|
|
|
include::licensing/put-license.asciidoc[]
|
2018-08-10 04:55:25 -04:00
|
|
|
include::licensing/get-license.asciidoc[]
|
2018-08-14 05:55:54 -04:00
|
|
|
include::licensing/delete-license.asciidoc[]
|
2018-10-17 11:02:04 -04:00
|
|
|
include::licensing/start-trial.asciidoc[]
|
2018-10-16 09:21:30 -04:00
|
|
|
include::licensing/start-basic.asciidoc[]
|
2018-08-10 08:12:42 -04:00
|
|
|
|
2018-08-14 14:52:54 -04:00
|
|
|
== Machine Learning APIs
|
2018-10-04 14:28:44 -04:00
|
|
|
:upid: {mainid}-x-pack-ml
|
|
|
|
:doc-tests-file: {doc-tests}/MlClientDocumentationIT.java
|
2018-08-14 14:52:54 -04:00
|
|
|
|
|
|
|
The Java High Level REST Client supports the following Machine Learning APIs:
|
|
|
|
|
2018-10-04 14:28:44 -04:00
|
|
|
* <<{upid}-put-job>>
|
|
|
|
* <<{upid}-get-job>>
|
|
|
|
* <<{upid}-delete-job>>
|
|
|
|
* <<{upid}-open-job>>
|
|
|
|
* <<{upid}-close-job>>
|
|
|
|
* <<{upid}-flush-job>>
|
|
|
|
* <<{upid}-update-job>>
|
|
|
|
* <<{upid}-get-job-stats>>
|
|
|
|
* <<{upid}-put-datafeed>>
|
|
|
|
* <<{upid}-get-datafeed>>
|
|
|
|
* <<{upid}-delete-datafeed>>
|
|
|
|
* <<{upid}-preview-datafeed>>
|
|
|
|
* <<{upid}-start-datafeed>>
|
|
|
|
* <<{upid}-stop-datafeed>>
|
2018-10-04 17:43:06 -04:00
|
|
|
* <<{upid}-get-datafeed-stats>>
|
2018-10-04 14:28:44 -04:00
|
|
|
* <<{upid}-forecast-job>>
|
|
|
|
* <<{upid}-delete-forecast>>
|
|
|
|
* <<{upid}-get-buckets>>
|
|
|
|
* <<{upid}-get-overall-buckets>>
|
|
|
|
* <<{upid}-get-records>>
|
|
|
|
* <<{upid}-post-data>>
|
|
|
|
* <<{upid}-get-influencers>>
|
|
|
|
* <<{upid}-get-categories>>
|
|
|
|
* <<{upid}-get-calendars>>
|
|
|
|
* <<{upid}-put-calendar>>
|
|
|
|
* <<{upid}-delete-calendar>>
|
2018-08-14 14:52:54 -04:00
|
|
|
|
2018-08-15 14:19:41 -04:00
|
|
|
include::ml/put-job.asciidoc[]
|
2018-08-21 22:02:28 -04:00
|
|
|
include::ml/get-job.asciidoc[]
|
2018-08-16 08:18:43 -04:00
|
|
|
include::ml/delete-job.asciidoc[]
|
2018-08-15 14:19:41 -04:00
|
|
|
include::ml/open-job.asciidoc[]
|
2018-08-20 17:05:56 -04:00
|
|
|
include::ml/close-job.asciidoc[]
|
2018-09-06 08:18:09 -04:00
|
|
|
include::ml/update-job.asciidoc[]
|
2018-09-01 17:01:23 -04:00
|
|
|
include::ml/flush-job.asciidoc[]
|
2018-09-12 09:52:36 -04:00
|
|
|
include::ml/put-datafeed.asciidoc[]
|
2018-09-16 06:54:55 -04:00
|
|
|
include::ml/get-datafeed.asciidoc[]
|
2018-09-13 12:13:36 -04:00
|
|
|
include::ml/delete-datafeed.asciidoc[]
|
2018-10-04 14:28:44 -04:00
|
|
|
include::ml/preview-datafeed.asciidoc[]
|
2018-09-21 08:56:38 -04:00
|
|
|
include::ml/start-datafeed.asciidoc[]
|
2018-09-21 15:13:35 -04:00
|
|
|
include::ml/stop-datafeed.asciidoc[]
|
2018-10-04 17:43:06 -04:00
|
|
|
include::ml/get-datafeed-stats.asciidoc[]
|
2018-09-01 14:32:18 -04:00
|
|
|
include::ml/get-job-stats.asciidoc[]
|
2018-09-07 12:16:58 -04:00
|
|
|
include::ml/forecast-job.asciidoc[]
|
2018-09-11 19:32:52 -04:00
|
|
|
include::ml/delete-forecast.asciidoc[]
|
2018-08-23 04:35:06 -04:00
|
|
|
include::ml/get-buckets.asciidoc[]
|
2018-09-03 08:34:36 -04:00
|
|
|
include::ml/get-overall-buckets.asciidoc[]
|
2018-08-29 10:03:58 -04:00
|
|
|
include::ml/get-records.asciidoc[]
|
2018-09-07 08:04:27 -04:00
|
|
|
include::ml/post-data.asciidoc[]
|
2018-09-05 10:06:55 -04:00
|
|
|
include::ml/get-influencers.asciidoc[]
|
2018-09-11 07:48:14 -04:00
|
|
|
include::ml/get-categories.asciidoc[]
|
2018-09-18 06:51:11 -04:00
|
|
|
include::ml/get-calendars.asciidoc[]
|
2018-09-14 10:00:18 -04:00
|
|
|
include::ml/put-calendar.asciidoc[]
|
2018-09-19 05:20:21 -04:00
|
|
|
include::ml/delete-calendar.asciidoc[]
|
2018-08-14 14:52:54 -04:00
|
|
|
|
2018-08-13 05:05:27 -04:00
|
|
|
== Migration APIs
|
|
|
|
|
|
|
|
The Java High Level REST Client supports the following Migration APIs:
|
|
|
|
|
|
|
|
* <<java-rest-high-migration-get-assistance>>
|
|
|
|
|
|
|
|
include::migration/get-assistance.asciidoc[]
|
|
|
|
|
2018-09-17 03:10:23 -04:00
|
|
|
== Rollup APIs
|
|
|
|
|
2018-10-16 09:02:29 -04:00
|
|
|
:upid: {mainid}-rollup
|
|
|
|
:doc-tests-file: {doc-tests}/RollupDocumentationIT.java
|
|
|
|
|
2018-09-17 03:10:23 -04:00
|
|
|
The Java High Level REST Client supports the following Rollup APIs:
|
|
|
|
|
|
|
|
* <<java-rest-high-x-pack-rollup-put-job>>
|
2018-10-16 09:02:29 -04:00
|
|
|
* <<{upid}-rollup-delete-job>>
|
2018-10-02 09:11:29 -04:00
|
|
|
* <<java-rest-high-x-pack-rollup-get-job>>
|
2018-10-18 17:12:38 -04:00
|
|
|
* <<{upid}-x-pack-rollup-get-rollup-caps>>
|
2018-09-17 03:10:23 -04:00
|
|
|
|
|
|
|
include::rollup/put_job.asciidoc[]
|
2018-10-16 09:02:29 -04:00
|
|
|
include::rollup/delete_job.asciidoc[]
|
2018-10-02 09:11:29 -04:00
|
|
|
include::rollup/get_job.asciidoc[]
|
2018-10-18 17:12:38 -04:00
|
|
|
include::rollup/get_rollup_caps.asciidoc[]
|
2018-09-17 03:10:23 -04:00
|
|
|
|
2018-09-07 13:51:37 -04:00
|
|
|
== Security APIs
|
|
|
|
|
2018-10-20 06:11:36 -04:00
|
|
|
:upid: {mainid}-security
|
|
|
|
:doc-tests-file: {doc-tests}/SecurityDocumentationIT.java
|
|
|
|
|
2018-09-07 13:51:37 -04:00
|
|
|
The Java High Level REST Client supports the following Security APIs:
|
|
|
|
|
|
|
|
* <<java-rest-high-security-put-user>>
|
|
|
|
* <<java-rest-high-security-enable-user>>
|
|
|
|
* <<java-rest-high-security-disable-user>>
|
2018-10-02 06:23:13 -04:00
|
|
|
* <<java-rest-high-security-change-password>>
|
2018-10-20 06:11:36 -04:00
|
|
|
* <<java-rest-high-security-delete-role>>
|
2018-10-15 12:20:34 -04:00
|
|
|
* <<java-rest-high-security-get-certificates>>
|
2018-10-15 22:05:46 -04:00
|
|
|
* <<java-rest-high-security-put-role-mapping>>
|
2018-10-18 22:46:26 -04:00
|
|
|
* <<java-rest-high-security-delete-role-mapping>>
|
2018-09-07 13:51:37 -04:00
|
|
|
|
|
|
|
include::security/put-user.asciidoc[]
|
|
|
|
include::security/enable-user.asciidoc[]
|
|
|
|
include::security/disable-user.asciidoc[]
|
2018-10-02 06:23:13 -04:00
|
|
|
include::security/change-password.asciidoc[]
|
2018-10-20 06:11:36 -04:00
|
|
|
include::security/delete-role.asciidoc[]
|
2018-10-15 12:20:34 -04:00
|
|
|
include::security/get-certificates.asciidoc[]
|
2018-10-15 22:05:46 -04:00
|
|
|
include::security/put-role-mapping.asciidoc[]
|
2018-10-18 22:46:26 -04:00
|
|
|
include::security/delete-role-mapping.asciidoc[]
|
2018-09-07 13:51:37 -04:00
|
|
|
|
2018-08-10 08:12:42 -04:00
|
|
|
== Watcher APIs
|
|
|
|
|
2018-10-04 17:30:20 -04:00
|
|
|
:upid: {mainid}-watcher
|
2018-10-04 06:49:52 -04:00
|
|
|
:doc-tests-file: {doc-tests}/WatcherDocumentationIT.java
|
|
|
|
|
2018-08-10 08:12:42 -04:00
|
|
|
The Java High Level REST Client supports the following Watcher APIs:
|
|
|
|
|
2018-10-19 14:52:15 -04:00
|
|
|
* <<{upid}-start-watch-service>>
|
|
|
|
* <<{upid}-stop-watch-service>>
|
2018-08-10 08:12:42 -04:00
|
|
|
* <<java-rest-high-x-pack-watcher-put-watch>>
|
|
|
|
* <<java-rest-high-x-pack-watcher-delete-watch>>
|
2018-10-04 17:30:20 -04:00
|
|
|
* <<{upid}-ack-watch>>
|
2018-10-04 06:49:52 -04:00
|
|
|
* <<{upid}-activate-watch>>
|
2018-08-10 08:12:42 -04:00
|
|
|
|
2018-10-19 12:42:57 -04:00
|
|
|
include::watcher/start-watch-service.asciidoc[]
|
|
|
|
include::watcher/stop-watch-service.asciidoc[]
|
2018-08-10 08:12:42 -04:00
|
|
|
include::watcher/put-watch.asciidoc[]
|
|
|
|
include::watcher/delete-watch.asciidoc[]
|
2018-10-03 05:03:03 -04:00
|
|
|
include::watcher/ack-watch.asciidoc[]
|
2018-10-04 06:49:52 -04:00
|
|
|
include::watcher/activate-watch.asciidoc[]
|
2018-08-21 08:29:18 -04:00
|
|
|
|
|
|
|
== Graph APIs
|
|
|
|
|
|
|
|
The Java High Level REST Client supports the following Graph APIs:
|
|
|
|
|
|
|
|
* <<java-rest-high-x-pack-graph-explore>>
|
|
|
|
|
|
|
|
include::graph/explore.asciidoc[]
|
2018-09-28 14:48:11 -04:00
|
|
|
|
|
|
|
////
|
|
|
|
Clear attributes that we use to document that APIs included above so they
|
|
|
|
don't leak into the rest of the documentation.
|
|
|
|
////
|
|
|
|
--
|
|
|
|
:api!:
|
|
|
|
:request!:
|
|
|
|
:response!:
|
|
|
|
:doc-tests-file!:
|
|
|
|
:upid!:
|
2018-10-24 14:27:22 -04:00
|
|
|
--
|