honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/java-rest/high-level/supported-apis.asciidoc

549 lines
16 KiB
Plaintext
Raw Normal View History

[Docs] Add migration notes for the high-level rest client (#25911)
2017-08-01 04:38:56 -04:00
[[java-rest-high-supported-apis]]
Add first High level client documentation The REST Client is split into 2 parts: * Low level * High level The High level client has a main common section and the document delete API documentation as a start.
2017-02-24 07:52:36 -05:00
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
== Document APIs
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -04:00
:upid: {mainid}-document
:doc-tests-file: {doc-tests}/CRUDDocumentationIT.java
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
The Java High Level REST Client supports the following Document APIs:
Add Delete Index API support to high-level REST client (#27019) Relates to #25847
2017-10-26 03:52:46 -04:00
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
[[single-doc]]
[Docs] Add "Using Java Builders" section (#26517) The current "Building Queries" and "Building Aggregations" pages are located under the "Supported Apis" section because they are linked to the "Search API" page. It should instead be in a dedicated section: this commit adds a new "Using Java Builders" section and renames few filenames in favor of more meaningful names.
2017-09-06 08:06:41 -04:00
Single document APIs::
Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -04:00
* <<{upid}-index>>
* <<{upid}-get>>
Docs: DRY up CRUD docs (#34203) This further applies the pattern set in #34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in #34163.
2018-10-05 11:41:03 -04:00
* <<{upid}-exists>>
Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -04:00
* <<{upid}-delete>>
* <<{upid}-update>>
HLRC API for _termvectors (#33447) * HLRC API for _termvectors relates to #27205
2018-10-24 14:27:22 -04:00
* <<{upid}-term-vectors>>
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
[[multi-doc]]
Multi-document APIs::
Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -04:00
* <<{upid}-bulk>>
* <<{upid}-multi-get>>
* <<{upid}-reindex>>
* <<{upid}-update-by-query>>
* <<{upid}-delete-by-query>>
[Docs] Fix broken link for HLRC rethrottle
2018-10-02 17:13:08 -04:00
* <<{upid}-rethrottle>>
HLRC for _mtermvectors (#35266) relates to #27205
2018-11-19 12:24:31 -05:00
* <<{upid}-multi-term-vectors>>
[DOCS] add docs for REST high level client index method (#25501) This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 04:48:16 -04:00
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
include::document/index.asciidoc[]
include::document/get.asciidoc[]
Docs: HighLevelRestClient#exists (#29073) Docs: HighLevelRestClient#exists Add documentation for `HighLevelRestClient#exists`. Relates to #28389
2018-03-15 12:10:30 -04:00
include::document/exists.asciidoc[]
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
include::document/delete.asciidoc[]
include::document/update.asciidoc[]
HLRC API for _termvectors (#33447) * HLRC API for _termvectors relates to #27205
2018-10-24 14:27:22 -04:00
include::document/term-vectors.asciidoc[]
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
include::document/bulk.asciidoc[]
Docs: HighLevelRestClient#multiGet (#29095) Add documentation for HighLevelRestClient#multiGet. Relates to #28389.
2018-03-16 18:52:34 -04:00
include::document/multi-get.asciidoc[]
HLREST: add reindex API (#32679) Adds the reindex API to the high level REST client.
2018-08-28 13:02:23 -04:00
include::document/reindex.asciidoc[]
HLREST: add update by query API (#32760) Adds update by query to the high level rest client.
2018-09-02 15:15:00 -04:00
include::document/update-by-query.asciidoc[]
HLRC: Add delete by query API (#32782) Adds the delete-by-query API to the High Level REST Client.
2018-09-04 08:56:26 -04:00
include::document/delete-by-query.asciidoc[]
HLRC: Add throttling for update & delete-by-query (#33951) This change adds throttling to the update-by-query and delete-by-query cases similar to throttling for reindex. This mostly means additional methods on the client class itself, since the request hits the same RestHandler, just with slightly different endpoints, and also the return values are similar.
2018-10-02 15:44:15 -04:00
include::document/rethrottle.asciidoc[]
HLRC for _mtermvectors (#35266) relates to #27205
2018-11-19 12:24:31 -05:00
include::document/multi-term-vectors.asciidoc[]
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
== Search APIs
Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -04:00
:upid: {mainid}
:doc-tests-file: {doc-tests}/SearchDocumentationIT.java
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
The Java High Level REST Client supports the following Search APIs:
Docs: DRY up HLRC index docs (#34157) Use tricks pioneered in #34125 to shorted asciidoc for the index API's docs. Also slightly shorten the supported-api docs file.
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>>
HLRC: Add document _count API (#34267) Add `count()` api method, `CountRequest` and `CountResponse` classes to HLRC. Code in server module is unchanged. Relates to #27205
2018-11-02 09:21:19 -04:00
* <<{upid}-count>>
[Docs] Add migration notes for the high-level rest client (#25911)
2017-08-01 04:38:56 -04:00
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
include::search/search.asciidoc[]
include::search/scroll.asciidoc[]
Docs: HighLevelRestClient#multiSearch (#29144) Adds docs for `HighLevelRestClient#multiSearch`. Unlike the `multiGet` docs these are much more sparse because multi-search doesn't support setting many options on the `MultiSearchRequest` and instead just wraps a list of `SearchRequest`s. Closes #28389
2018-03-23 10:11:50 -04:00
include::search/multi-search.asciidoc[]
Add support for search templates to the high-level REST client. (#30473)
2018-05-15 16:07:58 -04:00
include::search/search-template.asciidoc[]
Add MultiSearchTemplate support to High Level Rest client (#30836) Add MultiSearchTemplate support to High Level Rest client. Addresses part of #27205
2018-06-28 09:05:26 -04:00
include::search/multi-search-template.asciidoc[]
Add support for field capabilities to the high-level REST client. (#29664)
2018-04-26 12:50:37 -04:00
include::search/field-caps.asciidoc[]
[Docs] Add rankEval method for Jva HL client This change adds documentation about using the ranking evaluation API from the high level Java REST client. Closes #28694
2018-04-10 04:15:31 -04:00
include::search/rank-eval.asciidoc[]
Add explain API to high-level REST client (#31387) Relates to #27205
2018-06-27 09:20:56 -04:00
include::search/explain.asciidoc[]
HLRC: Add document _count API (#34267) Add `count()` api method, `CountRequest` and `CountResponse` classes to HLRC. Code in server module is unchanged. Relates to #27205
2018-11-02 09:21:19 -04:00
include::search/count.asciidoc[]
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
== Miscellaneous APIs
The Java High Level REST Client supports the following Miscellaneous APIs:
[Docs] Add migration notes for the high-level rest client (#25911)
2017-08-01 04:38:56 -04:00
* <<java-rest-high-main>>
Docs: HighLevelRestClient#ping (#29070) Add documentation for `HighLevelRestClient#ping`. Relates to #28389
2018-03-14 14:27:01 -04:00
* <<java-rest-high-ping>>
HLREST: Add x-pack-info API (#31870) This is the first x-pack API we're adding to the high level REST client so there is a lot to talk about here! = Open source The *client* for these APIs is open source. We're taking the previously Elastic licensed files used for the `Request` and `Response` objects and relicensing them under the Apache 2 license. The implementation of these features is staying under the Elastic license. This lines up with how the rest of the Elasticsearch language clients work. = Location of the new files We're moving all of the `Request` and `Response` objects that we're relicensing to the `x-pack/protocol` directory. We're adding a copy of the Apache 2 license to the root fo the `x-pack/protocol` directory to line up with the language in the root `LICENSE.txt` file. All files in this directory will have the Apache 2 license header as well. We don't want there to be any confusion. Even though the files are under the `x-pack` directory, they are Apache 2 licensed. We chose this particular directory layout because it keeps the X-Pack stuff together and easier to think about. = Location of the API in the REST client We've been following the layout of the rest-api-spec files for other APIs and we plan to do this for the X-Pack APIs with one exception: we're dropping the `xpack` from the name of most of the APIs. So `xpack.graph.explore` will become `graph().explore()` and `xpack.license.get` will become `license().get()`. `xpack.info` and `xpack.usage` are special here though because they don't belong to any proper category. For now I'm just calling `xpack.info` `xPackInfo()` and intend to call usage `xPackUsage` though I'm not convinced that this is the final name for them. But it does get us started. = Jars, jars everywhere! This change makes the `xpack:protocol` project a `compile` scoped dependency of the `x-pack:plugin:core` and `client:rest-high-level` projects. I intend to keep it a compile scoped dependency of `x-pack:plugin:core` but I intend to bundle the contents of the protocol jar into the `client:rest-high-level` jar in a follow up. This change has grown large enough at this point. In that followup I'll address javadoc issues as well. = Breaking-Java This breaks that transport client by a few classes around. We've traditionally been ok with doing this to the transport client.
2018-07-08 11:03:56 -04:00
* <<java-rest-high-x-pack-info>>
[DOCS] Adjust high-level client x-pack docs (#32747) - Expose x-pack usage docs page which was not linked in supported-apis page - make watcher a top-level dir outside of x-pack directory - move x-pack info and usage pages to miscellaneous - add new Watcher category to supported-apis (they were under miscellaneous) - remove x-pack prefix from watcher docs titles
2018-08-10 08:12:42 -04:00
* <<java-rest-high-x-pack-usage>>
[Docs] Add "Using Java Builders" section (#26517) The current "Building Queries" and "Building Aggregations" pages are located under the "Supported Apis" section because they are linked to the "Search API" page. It should instead be in a dedicated section: this commit adds a new "Using Java Builders" section and renames few filenames in favor of more meaningful names.
2017-09-06 08:06:41 -04:00
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
include::miscellaneous/main.asciidoc[]
Docs: HighLevelRestClient#ping (#29070) Add documentation for `HighLevelRestClient#ping`. Relates to #28389
2018-03-14 14:27:01 -04:00
include::miscellaneous/ping.asciidoc[]
[DOCS] Adjust high-level client x-pack docs (#32747) - Expose x-pack usage docs page which was not linked in supported-apis page - make watcher a top-level dir outside of x-pack directory - move x-pack info and usage pages to miscellaneous - add new Watcher category to supported-apis (they were under miscellaneous) - remove x-pack prefix from watcher docs titles
2018-08-10 08:12:42 -04:00
include::miscellaneous/x-pack-info.asciidoc[]
include::miscellaneous/x-pack-usage.asciidoc[]
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
== Indices APIs
Docs: DRY up indices docs (#35971) This commit DRYs up the indices folder as well as fixing a few minor mishaps that were in the docs.
2018-11-27 20:40:49 -05:00
:upid: {mainid}
:doc-tests-file: {doc-tests}/IndicesClientDocumentationIT.java
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
The Java High Level REST Client supports the following Indices APIs:
Index Management::
Docs: DRY up indices docs (#35971) This commit DRYs up the indices folder as well as fixing a few minor mishaps that were in the docs.
2018-11-27 20:40:49 -05:00
* <<{upid}-analyze>>
* <<{upid}-create-index>>
* <<{upid}-delete-index>>
* <<{upid}-indices-exists>>
* <<{upid}-open-index>>
* <<{upid}-close-index>>
* <<{upid}-shrink-index>>
* <<{upid}-split-index>>
* <<{upid}-refresh>>
* <<{upid}-flush>>
* <<{upid}-flush-synced>>
* <<{upid}-clear-cache>>
* <<{upid}-force-merge>>
* <<{upid}-rollover-index>>
* <<{upid}-indices-put-settings>>
* <<{upid}-get-settings>>
* <<{upid}-indices-validate-query>>
* <<{upid}-get-index>>
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
Mapping Management::
Docs: DRY up indices docs (#35971) This commit DRYs up the indices folder as well as fixing a few minor mishaps that were in the docs.
2018-11-27 20:40:49 -05:00
* <<{upid}-put-mapping>>
* <<{upid}-get-mappings>>
* <<{upid}-get-field-mappings>>
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
Alias Management::
Docs: DRY up indices docs (#35971) This commit DRYs up the indices folder as well as fixing a few minor mishaps that were in the docs.
2018-11-27 20:40:49 -05:00
* <<{upid}-update-aliases>>
* <<{upid}-exists-alias>>
* <<{upid}-get-alias>>
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
[hlrc] add index templates exist API (#36132) This commit adds support for the index templates exist API, creating new client-side request types for that API and the get index templates API. Also adds links in hlrc docs to pages for supported index template APIs
2018-12-10 11:11:57 -05:00
Template Management::
* <<{upid}-get-templates>>
* <<{upid}-templates-exist>>
* <<{upid}-put-template>>
Add analyze API to high-level rest client (#31577)
2018-07-03 10:57:02 -04:00
include::indices/analyze.asciidoc[]
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
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[]
Add Refresh API for RestHighLevelClient (#27799) Relates to #27205
2018-02-28 05:49:14 -05:00
include::indices/refresh.asciidoc[]
REST high-level client: add flush API (#28852) Relates to #27205
2018-03-01 04:56:03 -05:00
include::indices/flush.asciidoc[]
REST high-level client: add synced flush API (2) (#30650) Adds the synced flush API to the high level REST client. Relates to #27205.
2018-05-30 07:32:52 -04:00
include::indices/flush_synced.asciidoc[]
REST high-level client: add clear cache API (#28866) * REST high-level client: add clear cache API Relates to #27205 Also Closes #26947 (rest-spec were outdated)
2018-03-20 05:39:36 -04:00
include::indices/clear_cache.asciidoc[]
REST high-level client: add force merge API (#28896) Relates to #27205
2018-03-22 12:17:16 -04:00
include::indices/force_merge.asciidoc[]
REST high-level client: add support for Rollover Index API (#28698) Relates to #27205
2018-02-20 09:58:58 -05:00
include::indices/rollover.asciidoc[]
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
include::indices/put_mapping.asciidoc[]
Add get mappings support to high-level rest client (#30889) This adds support for the get mappings API to the high level rest client. Relates to #27205
2018-06-04 16:31:08 -04:00
include::indices/get_mappings.asciidoc[]
Add get field mappings to High Level REST API Client (#31423) Add get field mappings to High Level REST API Client Relates to #27205
2018-06-23 03:39:17 -04:00
include::indices/get_field_mappings.asciidoc[]
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
include::indices/update_aliases.asciidoc[]
include::indices/exists_alias.asciidoc[]
Add Get Aliases API to the high-level REST client (#28799) Given the weirdness of the response returned by the get alias API, we went for a client specific response, which allows us to hold the error message, exception and status returned as part of the response together with aliases. See #30536 . Relates to #27205
2018-06-12 04:26:17 -04:00
include::indices/get_alias.asciidoc[]
REST high-level client: add support for Indices Update Settings API [take 2] (#29327) Relates to #27205
2018-04-16 15:39:11 -04:00
include::indices/put_settings.asciidoc[]
Add Get Settings API support to java high-level rest client (#29229) This PR adds support for the Get Settings API to the java high-level rest client. Furthermore, logic related to the retrieval of default settings has been moved from the rest layer into the transport layer and now default settings may be retrieved consistency via both the rest API and the transport API.
2018-05-04 11:14:28 -04:00
include::indices/get_settings.asciidoc[]
Add put index template api to high level rest client (#30400) Relates #27205
2018-05-06 09:47:36 -04:00
include::indices/put_template.asciidoc[]
REST high-level client: add validate query API (#31077) Adds the validate query API to the high level rest client.
2018-06-18 09:59:29 -04:00
include::indices/validate_query.asciidoc[]
HLRest: Add get index templates API (#31161) Relates #27205
2018-06-11 11:06:28 -04:00
include::indices/get_templates.asciidoc[]
[hlrc] add index templates exist API (#36132) This commit adds support for the index templates exist API, creating new client-side request types for that API and the get index templates API. Also adds links in hlrc docs to pages for supported index template APIs
2018-12-10 11:11:57 -05:00
include::indices/templates_exist.asciidoc[]
REST high-level client: add get index API (#31703) Also added master_timeout parameter for the indices.get spec Relates to #27205
2018-07-05 13:52:25 -04:00
include::indices/get_index.asciidoc[]
Add high-level REST client API for `_freeze` and `_unfreeze` (#35723) This change adds support for `_freeze` and `_unfreeze` to the HLRC Relates to #34352
2018-11-28 09:42:12 -05:00
include::indices/freeze_index.asciidoc[]
include::indices/unfreeze_index.asciidoc[]
HLRC: Add delete template API (#36320) Relates #27205
2018-12-07 10:46:03 -05:00
include::indices/delete_template.asciidoc[]
[DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 11:19:50 -05:00
Add Cluster Put Settings API to the high level REST client (#28633) Relates to #27205
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>>
rest-high-level: added get cluster settings (#31706) Relates to #27205
2018-07-02 13:25:17 -04:00
* <<java-rest-high-cluster-get-settings>>
REST high-level client: add Cluster Health API (#29331) Relates to #27205
2018-06-12 07:34:06 -04:00
* <<java-rest-high-cluster-health>>
Add Cluster Put Settings API to the high level REST client (#28633) Relates to #27205
2018-02-15 11:21:45 -05:00
Docs: Cut down on high level rest client copy-and-paste-ness (#34125) * Anchors * includes * get settings * more * More
2018-09-28 14:48:11 -04:00
:upid: {mainid}-cluster
:doc-tests-file: {doc-tests}/ClusterClientDocumentationIT.java
Add Cluster Put Settings API to the high level REST client (#28633) Relates to #27205
2018-02-15 11:21:45 -05:00
include::cluster/put_settings.asciidoc[]
rest-high-level: added get cluster settings (#31706) Relates to #27205
2018-07-02 13:25:17 -04:00
include::cluster/get_settings.asciidoc[]
REST high-level client: add Cluster Health API (#29331) Relates to #27205
2018-06-12 07:34:06 -04:00
include::cluster/health.asciidoc[]
Move pipeline APIs to ingest namespace (#31027)
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>>
REST high-level client: add simulate pipeline API (#31158) relates to #27205
2018-06-22 03:59:04 -04:00
* <<java-rest-high-ingest-simulate-pipeline>>
Move pipeline APIs to ingest namespace (#31027)
2018-06-04 04:34:55 -04:00
include::ingest/put_pipeline.asciidoc[]
include::ingest/get_pipeline.asciidoc[]
include::ingest/delete_pipeline.asciidoc[]
REST high-level client: add simulate pipeline API (#31158) relates to #27205
2018-06-22 03:59:04 -04:00
include::ingest/simulate_pipeline.asciidoc[]
Add GET Repository High Level REST API (#30362) This commit adds the Snapshot Client with a first API call within it, the get repositories call in snapshot/restore module. This also creates a snapshot namespace for the docs, as well as get repositories docs. Relates #27205
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>>
Add Delete Repository High Level REST API (#30666) This commit adds Delete Repository, the associated docs and tests for the high level REST API client. It also cleans up a seemingly innocuous line in the RestDeleteRepositoryAction and some naming in SnapshotIT. Relates #27205
2018-05-21 20:52:21 -04:00
* <<java-rest-high-snapshot-create-repository>>
* <<java-rest-high-snapshot-delete-repository>>
Add Verify Repository High Level REST API (#30934) This commit adds Verify Repository, the associated docs and tests for the high level REST API client. A few small changes to the Verify Repository Response went into the commit as well. Relates #27205
2018-05-30 12:10:00 -04:00
* <<java-rest-high-snapshot-verify-repository>>
Add Create Snapshot to High-Level Rest Client (#31215) Added support to the high-level rest client for the create snapshot API call. This required several changes to toXContent which may need to be cleaned up in a later PR. Also added several parsers for fromXContent to be able to retrieve appropriate responses along with tests.
2018-06-27 12:30:10 -04:00
* <<java-rest-high-snapshot-create-snapshot>>
Add Get Snapshots High Level REST API (#31537) With this commit we add the get snapshots API to the Java high level REST client. Relates #27205
2018-06-27 20:04:34 -04:00
* <<java-rest-high-snapshot-get-snapshots>>
Add Snapshots Status API to High Level Rest Client (#31515) This PR adds the Snapshots Status API to the Snapshot Client, as well as additional documentation for the status api.
2018-07-11 12:07:31 -04:00
* <<java-rest-high-snapshot-snapshots-status>>
Add Delete Snapshot High Level REST API With this commit we add the delete snapshot API to the Java high level REST client. Relates #27205 Relates #31393
2018-06-20 10:42:50 -04:00
* <<java-rest-high-snapshot-delete-snapshot>>
Add GET Repository High Level REST API (#30362) This commit adds the Snapshot Client with a first API call within it, the get repositories call in snapshot/restore module. This also creates a snapshot namespace for the docs, as well as get repositories docs. Relates #27205
2018-05-09 08:25:23 -04:00
Add Create Repository High Level REST API (#30501) This commit adds Create Repository, the associated docs and tests for the high level REST API client. A few small changes to the PutRepository Request and Response went into the commit as well.
2018-05-15 22:21:11 -04:00
include::snapshot/get_repository.asciidoc[]
Rest High Level client: Add List Tasks (#29546) This change adds a `listTasks` method to the high level java ClusterClient which allows listing running tasks through the task management API. Related to #27205
2018-05-16 07:31:37 -04:00
include::snapshot/create_repository.asciidoc[]
Add Delete Repository High Level REST API (#30666) This commit adds Delete Repository, the associated docs and tests for the high level REST API client. It also cleans up a seemingly innocuous line in the RestDeleteRepositoryAction and some naming in SnapshotIT. Relates #27205
2018-05-21 20:52:21 -04:00
include::snapshot/delete_repository.asciidoc[]
Add Verify Repository High Level REST API (#30934) This commit adds Verify Repository, the associated docs and tests for the high level REST API client. A few small changes to the Verify Repository Response went into the commit as well. Relates #27205
2018-05-30 12:10:00 -04:00
include::snapshot/verify_repository.asciidoc[]
Add Create Snapshot to High-Level Rest Client (#31215) Added support to the high-level rest client for the create snapshot API call. This required several changes to toXContent which may need to be cleaned up in a later PR. Also added several parsers for fromXContent to be able to retrieve appropriate responses along with tests.
2018-06-27 12:30:10 -04:00
include::snapshot/create_snapshot.asciidoc[]
Add Get Snapshots High Level REST API (#31537) With this commit we add the get snapshots API to the Java high level REST client. Relates #27205
2018-06-27 20:04:34 -04:00
include::snapshot/get_snapshots.asciidoc[]
Add Snapshots Status API to High Level Rest Client (#31515) This PR adds the Snapshots Status API to the Snapshot Client, as well as additional documentation for the status api.
2018-07-11 12:07:31 -04:00
include::snapshot/snapshots_status.asciidoc[]
Add Delete Snapshot High Level REST API With this commit we add the delete snapshot API to the Java high level REST client. Relates #27205 Relates #31393
2018-06-20 10:42:50 -04:00
include::snapshot/delete_snapshot.asciidoc[]
Move list tasks under Tasks namespace (#30906) Our API spec define the tasks API as e.g. tasks.list, meaning that they belong to their own namespace. This commit moves them from the cluster namespace to their own namespace. Relates to #29546
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>>
high level REST api: cancel task (#30745) * Initial commit of rest high level exposure of cancel task * fix javadocs * address some code review comments * update branch to use tasks namespace instead of cluster * High-level client: list tasks failure to not lose nodeId This commit reworks testing for `ListTasksResponse` so that random fields insertion can be tested and xcontent equivalence can be checked too. Proper exclusions need to be configured, and failures need to be tested separately. This helped finding a little problem, whenever there is a node failure returned, the nodeId was lost as it was never printed out as part of the exception toXContent. * added comment * merge from master * re-work CancelTasksResponseTests to separate XContent failure cases from non-failure cases * remove duplication of logic in parser creation * code review changes * refactor TasksClient to support RequestOptions * add tests for parent task id * address final PR review comments, mostly formatting and such
2018-06-07 17:02:23 -04:00
* <<java-rest-high-cluster-cancel-tasks>>
Move list tasks under Tasks namespace (#30906) Our API spec define the tasks API as e.g. tasks.list, meaning that they belong to their own namespace. This commit moves them from the cluster namespace to their own namespace. Relates to #29546
2018-05-29 04:54:41 -04:00
include::tasks/list_tasks.asciidoc[]
high level REST api: cancel task (#30745) * Initial commit of rest high level exposure of cancel task * fix javadocs * address some code review comments * update branch to use tasks namespace instead of cluster * High-level client: list tasks failure to not lose nodeId This commit reworks testing for `ListTasksResponse` so that random fields insertion can be tested and xcontent equivalence can be checked too. Proper exclusions need to be configured, and failures need to be tested separately. This helped finding a little problem, whenever there is a node failure returned, the nodeId was lost as it was never printed out as part of the exception toXContent. * added comment * merge from master * re-work CancelTasksResponseTests to separate XContent failure cases from non-failure cases * remove duplication of logic in parser creation * code review changes * refactor TasksClient to support RequestOptions * add tests for parent task id * address final PR review comments, mostly formatting and such
2018-06-07 17:02:23 -04:00
include::tasks/cancel_tasks.asciidoc[]
Add get stored script and delete stored script to high level REST API (#31355) Add get stored script and delete stored script to high level REST API Relates to #27205
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>>
HLRC: Add put stored script support to high-level rest client (#31323) Relates to #27205
2018-09-09 07:47:47 -04:00
* <<java-rest-high-put-stored-script>>
Add get stored script and delete stored script to high level REST API (#31355) Add get stored script and delete stored script to high level REST API Relates to #27205
2018-06-19 08:21:11 -04:00
* <<java-rest-high-delete-stored-script>>
include::script/get_script.asciidoc[]
HLRC: Add put stored script support to high-level rest client (#31323) Relates to #27205
2018-09-09 07:47:47 -04:00
include::script/put_script.asciidoc[]
Add get stored script and delete stored script to high level REST API (#31355) Add get stored script and delete stored script to high level REST API Relates to #27205
2018-06-19 08:21:11 -04:00
include::script/delete_script.asciidoc[]
Rest HL client: Add put license action (#32214) In the HL REST client we replace the License object with a string, because of complexity of this class. It is also not really needed on the client side since end-users are not interacting with the license besides passing it as a string to the server. Relates #29827
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>>
[DOCS] Add missing link to get license API docs (#32746)
2018-08-10 04:55:25 -04:00
* <<java-rest-high-get-license>>
HLRC: Add Delete License API (#32586) Relates to #29827
2018-08-14 05:55:54 -04:00
* <<java-rest-high-delete-license>>
add start trial API to HLRC (#33406) Introduces client-specific request and response classes that do not depend on the server The `type` parameter is named `licenseType` in the response class to be more descriptive. The parts that make up the acknowledged-required response are given slightly different names than their server-response types to be consistent with the naming in the put license API Tests do not cover all cases because the integ test cluster starts up with a trial license - this will be addressed in a future commit
2018-10-17 11:02:04 -04:00
* <<java-rest-high-start-trial>>
HLRC: Add support for XPack Post Start Basic Licence API (#33606) Relates to #29827
2018-10-16 09:21:30 -04:00
* <<java-rest-high-start-basic>>
HLRC: add support for get license basic/trial status API (#33176) Relates to #29827
2018-11-13 09:52:59 -05:00
* <<java-rest-high-get-trial-status>>
* <<java-rest-high-get-basic-status>>
Rest HL client: Add put license action (#32214) In the HL REST client we replace the License object with a string, because of complexity of this class. It is also not really needed on the client side since end-users are not interacting with the license besides passing it as a string to the server. Relates #29827
2018-07-24 14:19:07 -04:00
include::licensing/put-license.asciidoc[]
[DOCS] Add missing link to get license API docs (#32746)
2018-08-10 04:55:25 -04:00
include::licensing/get-license.asciidoc[]
HLRC: Add Delete License API (#32586) Relates to #29827
2018-08-14 05:55:54 -04:00
include::licensing/delete-license.asciidoc[]
add start trial API to HLRC (#33406) Introduces client-specific request and response classes that do not depend on the server The `type` parameter is named `licenseType` in the response class to be more descriptive. The parts that make up the acknowledged-required response are given slightly different names than their server-response types to be consistent with the naming in the put license API Tests do not cover all cases because the integ test cluster starts up with a trial license - this will be addressed in a future commit
2018-10-17 11:02:04 -04:00
include::licensing/start-trial.asciidoc[]
HLRC: Add support for XPack Post Start Basic Licence API (#33606) Relates to #29827
2018-10-16 09:21:30 -04:00
include::licensing/start-basic.asciidoc[]
HLRC: add support for get license basic/trial status API (#33176) Relates to #29827
2018-11-13 09:52:59 -05:00
include::licensing/get-trial-status.asciidoc[]
include::licensing/get-basic-status.asciidoc[]
[DOCS] Adjust high-level client x-pack docs (#32747) - Expose x-pack usage docs page which was not linked in supported-apis page - make watcher a top-level dir outside of x-pack directory - move x-pack info and usage pages to miscellaneous - add new Watcher category to supported-apis (they were under miscellaneous) - remove x-pack prefix from watcher docs titles
2018-08-10 08:12:42 -04:00
[ML] Add high level REST client docs for ML put job endpoint (#32843) Relates #29827 Relates #32726
2018-08-14 14:52:54 -04:00
== Machine Learning APIs
HLRC: ML Add preview datafeed api (#34284) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR
2018-10-04 14:28:44 -04:00
:upid: {mainid}-x-pack-ml
:doc-tests-file: {doc-tests}/MlClientDocumentationIT.java
[ML] Add high level REST client docs for ML put job endpoint (#32843) Relates #29827 Relates #32726
2018-08-14 14:52:54 -04:00
The Java High Level REST Client supports the following Machine Learning APIs:
HLRC: ML Add preview datafeed api (#34284) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR
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>>
HLRC: Adding Update datafeed API (#34882) * HLRC: Adding Update datafeed API * Addressing unused import * Adjusting docs and fixing minor comments * fixing comment
2018-10-26 17:44:12 -04:00
* <<{upid}-update-datafeed>>
HLRC: ML Add preview datafeed api (#34284) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR
2018-10-04 14:28:44 -04:00
* <<{upid}-get-datafeed>>
* <<{upid}-delete-datafeed>>
* <<{upid}-preview-datafeed>>
* <<{upid}-start-datafeed>>
* <<{upid}-stop-datafeed>>
HLRC: ML Adding get datafeed stats API (#34271) * HLRC: ML Adding get datafeed stats API * addressing PR comments * fixing field exclusion filter * removing unnecessary whitespace
2018-10-04 17:43:06 -04:00
* <<{upid}-get-datafeed-stats>>
HLRC: ML Add preview datafeed api (#34284) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR
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>>
HLRC: ML Get Calendar Events (#35747) * HLRC: ML Get Calendar Events * Addressing PR comments
2018-11-20 17:40:31 -05:00
* <<{upid}-get-calendar-events>>
HLRC ML Add Event To Calendar API (#35704) * HLRC: ML Adding Post event to calendar api * Fixing tests and serialization * removing unused import
2018-11-20 09:15:21 -05:00
* <<{upid}-post-calendar-event>>
HLRC: ML Delete event from Calendar (#35760) * HLRC: Delete event from calendar * adjusting tests * adjusting code to make it more readable
2018-11-21 17:22:04 -05:00
* <<{upid}-delete-calendar-event>>
HLRC: ML Add Job to Calendar API (#35666)
2018-11-19 12:41:49 -05:00
* <<{upid}-put-calendar-job>>
HLRC: ML Delete job from calendar (#35713)
2018-11-20 08:43:34 -05:00
* <<{upid}-delete-calendar-job>>
HLRC: ML Add preview datafeed api (#34284) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR
2018-10-04 14:28:44 -04:00
* <<{upid}-delete-calendar>>
HLRC: Add ML API PUT filter (#35175)
2018-11-05 09:56:53 -05:00
* <<{upid}-put-filter>>
HLRC: Adding ml get filters api (#35502) * HLRC: Adding ml get filters api * refactoring setId name
2018-11-13 15:53:32 -05:00
* <<{upid}-get-filters>>
HLRC: Adding ML Update Filter API (#35522) * HLRC: Adding ml get filters api * HLRC: Adding ML Update Filter API
2018-11-14 12:13:11 -05:00
* <<{upid}-update-filter>>
HLRC: Add ML delete filter action (#35382) * HLRC: Add ML delete filter action It adds delete ML filter action to the high level rest client. Relates #29827
2018-11-19 05:25:35 -05:00
* <<{upid}-delete-filter>>
* <<{upid}-get-model-snapshots>>
[HLRC][ML] Add ML revert model snapshot API (#35750) Relates to #29827
2018-11-21 04:10:37 -05:00
* <<{upid}-delete-model-snapshot>>
* <<{upid}-revert-model-snapshot>>
[HLRC][ML] Add ML update model snapshot API (#35537) (#35694) Relates to #29827
2018-11-20 07:18:29 -05:00
* <<{upid}-update-model-snapshot>>
[HLRC] XPack ML info action (#35777) Relates to #29827
2018-11-28 05:58:20 -05:00
* <<{upid}-get-ml-info>>
[HLRC][ML] Add delete expired data API (#35906) Relates to #29827
2018-11-26 11:15:54 -05:00
* <<{upid}-delete-expired-data>>
ML: Add upgrade mode docs, hlrc, and fix bug (#37942) * ML: Add upgrade mode docs, hlrc, and fix bug * [DOCS] Fixes build error and edits text * adjusting docs * Update docs/reference/ml/apis/set-upgrade-mode.asciidoc Co-Authored-By: benwtrent <ben.w.trent@gmail.com> * Update set-upgrade-mode.asciidoc * Update set-upgrade-mode.asciidoc
2019-01-30 07:51:11 -05:00
* <<{upid}-set-upgrade-mode>>
[ML] Add high level REST client docs for ML put job endpoint (#32843) Relates #29827 Relates #32726
2018-08-14 14:52:54 -04:00
HLRC: adding machine learning open job (#32860) * HLRC: adding machine learning open job HLRC: adding ML open job API call * Addressing @droberts195 comments and fixing minor style issue
2018-08-15 14:19:41 -04:00
include::ml/put-job.asciidoc[]
HLRC: Add ML Get Job (#32960) * HLRC: Adding GET ML Job info API * HLRC: Adding GET Job ML API * Fixing QueryPage license header * Adding serialization tests, addressing minor issues * Renaming querypage, changing the dependency on it * Making things immutable * Fixing build failure due to method rename
2018-08-21 22:02:28 -04:00
include::ml/get-job.asciidoc[]
HLRC: adding machine learning delete job (#32820) * HLRC: adding machine learning delete job * Fixing whitespace * Moving docs and tests around * Unifying ml asciidoc file naming convention
2018-08-16 08:18:43 -04:00
include::ml/delete-job.asciidoc[]
HLRC: adding machine learning open job (#32860) * HLRC: adding machine learning open job HLRC: adding ML open job API call * Addressing @droberts195 comments and fixing minor style issue
2018-08-15 14:19:41 -04:00
include::ml/open-job.asciidoc[]
HLRC: ML Close Job (#32943) * HLRC: Adding ML Close Job API HLRC: Adding ML Close Job API * reconciling request converters * Adding serialization tests and addressing PR comments * Changing constructor order
2018-08-20 17:05:56 -04:00
include::ml/close-job.asciidoc[]
HLRC: ML Update Job (#33392) * HLRC: ML Update Job
2018-09-06 08:18:09 -04:00
include::ml/update-job.asciidoc[]
HLRC: ML Flush job (#33187) * HLRC: ML Flush job * Fixing package, paths, and test * Addressing comments
2018-09-01 17:01:23 -04:00
include::ml/flush-job.asciidoc[]
[HLRC][ML] Add ML put datafeed API to HLRC (#33603) This also changes both `DatafeedConfig` and `DatafeedUpdate` to store the query and aggs as a bytes reference. This allows the client to remove its dependency to the named objects registry of the search module. Relates #29827
2018-09-12 09:52:36 -04:00
include::ml/put-datafeed.asciidoc[]
HLRC: Adding Update datafeed API (#34882) * HLRC: Adding Update datafeed API * Addressing unused import * Adjusting docs and fixing minor comments * fixing comment
2018-10-26 17:44:12 -04:00
include::ml/update-datafeed.asciidoc[]
[HLRC][ML] Add ML get datafeed API to HLRC (#33715) Relates #29827
2018-09-16 06:54:55 -04:00
include::ml/get-datafeed.asciidoc[]
[HLRC][ML] Add ML delete datafeed API to HLRC (#33667) Relates #29827
2018-09-13 12:13:36 -04:00
include::ml/delete-datafeed.asciidoc[]
HLRC: ML Add preview datafeed api (#34284) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR
2018-10-04 14:28:44 -04:00
include::ml/preview-datafeed.asciidoc[]
HLRC: ML start data feed API (#33898) * HLRC: ML start data feed API
2018-09-21 08:56:38 -04:00
include::ml/start-datafeed.asciidoc[]
HLRC: ML Stop datafeed API (#33946) * HLRC: ML stop data feed api
2018-09-21 15:13:35 -04:00
include::ml/stop-datafeed.asciidoc[]
HLRC: ML Adding get datafeed stats API (#34271) * HLRC: ML Adding get datafeed stats API * addressing PR comments * fixing field exclusion filter * removing unnecessary whitespace
2018-10-04 17:43:06 -04:00
include::ml/get-datafeed-stats.asciidoc[]
HLRC: Adding ML Job stats (#33183) * HLRC: Adding pojos for get job stats HLRC: Adding pojos for job stats request * HLRC: Adding job stats pojos * HLRC: ML job stats * Minor syntax changes and adding license headers * minor comment change * Moving to client package, minor changes * Addressing PR comments * removing bad sleep * addressing minor comment around test methods * adding toplevel random fields for tests * addressing minor review comments
2018-09-01 14:32:18 -04:00
include::ml/get-job-stats.asciidoc[]
HLRC: ML Forecast Job (#33506) * HLRC: ML Forecast job
2018-09-07 12:16:58 -04:00
include::ml/forecast-job.asciidoc[]
HLRC: ML Delete Forecast API (#33526) * HLRC: ML Delete Forecast API
2018-09-11 19:32:52 -04:00
include::ml/delete-forecast.asciidoc[]
HLRC: Add ML Get Buckets API (#33056) Relates #29827
2018-08-23 04:35:06 -04:00
include::ml/get-buckets.asciidoc[]
HLRC: Add ML get overall buckets API (#33297) Relates #29827
2018-09-03 08:34:36 -04:00
include::ml/get-overall-buckets.asciidoc[]
HLRC: Add ML Get Records API (#33085) Relates #29827
2018-08-29 10:03:58 -04:00
include::ml/get-records.asciidoc[]
HLRC: ML Post Data (#33443) * HLRC: ML Post data
2018-09-07 08:04:27 -04:00
include::ml/post-data.asciidoc[]
HLRC: Add ML get influencers API (#33389) Relates #29827
2018-09-05 10:06:55 -04:00
include::ml/get-influencers.asciidoc[]
HLRC: Add ML get categories API (#33465) HLRC: Adding the ML 'get categories' API
2018-09-11 07:48:14 -04:00
include::ml/get-categories.asciidoc[]
HLRC: Get ML calendars (#33760)
2018-09-18 06:51:11 -04:00
include::ml/get-calendars.asciidoc[]
HLRC: ML PUT Calendar (#33362)
2018-09-14 10:00:18 -04:00
include::ml/put-calendar.asciidoc[]
HLRC: ML Get Calendar Events (#35747) * HLRC: ML Get Calendar Events * Addressing PR comments
2018-11-20 17:40:31 -05:00
include::ml/get-calendar-events.asciidoc[]
HLRC ML Add Event To Calendar API (#35704) * HLRC: ML Adding Post event to calendar api * Fixing tests and serialization * removing unused import
2018-11-20 09:15:21 -05:00
include::ml/post-calendar-event.asciidoc[]
HLRC: ML Delete event from Calendar (#35760) * HLRC: Delete event from calendar * adjusting tests * adjusting code to make it more readable
2018-11-21 17:22:04 -05:00
include::ml/delete-calendar-event.asciidoc[]
HLRC: ML Add Job to Calendar API (#35666)
2018-11-19 12:41:49 -05:00
include::ml/put-calendar-job.asciidoc[]
HLRC: ML Delete job from calendar (#35713)
2018-11-20 08:43:34 -05:00
include::ml/delete-calendar-job.asciidoc[]
HLRC: Delete ML calendar (#33775)
2018-09-19 05:20:21 -04:00
include::ml/delete-calendar.asciidoc[]
HLRC: Add ML API PUT filter (#35175)
2018-11-05 09:56:53 -05:00
include::ml/put-filter.asciidoc[]
HLRC: Adding ml get filters api (#35502) * HLRC: Adding ml get filters api * refactoring setId name
2018-11-13 15:53:32 -05:00
include::ml/get-filters.asciidoc[]
HLRC: Adding ML Update Filter API (#35522) * HLRC: Adding ml get filters api * HLRC: Adding ML Update Filter API
2018-11-14 12:13:11 -05:00
include::ml/update-filter.asciidoc[]
HLRC: Add ML delete filter action (#35382) * HLRC: Add ML delete filter action It adds delete ML filter action to the high level rest client. Relates #29827
2018-11-19 05:25:35 -05:00
include::ml/delete-filter.asciidoc[]
[HLRC][ML] Add ML revert model snapshot API (#35750) Relates to #29827
2018-11-21 04:10:37 -05:00
include::ml/get-model-snapshots.asciidoc[]
include::ml/delete-model-snapshot.asciidoc[]
include::ml/revert-model-snapshot.asciidoc[]
[HLRC][ML] Add ML update model snapshot API (#35537) (#35694) Relates to #29827
2018-11-20 07:18:29 -05:00
include::ml/update-model-snapshot.asciidoc[]
[HLRC] XPack ML info action (#35777) Relates to #29827
2018-11-28 05:58:20 -05:00
include::ml/get-info.asciidoc[]
[HLRC][ML] Add delete expired data API (#35906) Relates to #29827
2018-11-26 11:15:54 -05:00
include::ml/delete-expired-data.asciidoc[]
ML: Add upgrade mode docs, hlrc, and fix bug (#37942) * ML: Add upgrade mode docs, hlrc, and fix bug * [DOCS] Fixes build error and edits text * adjusting docs * Update docs/reference/ml/apis/set-upgrade-mode.asciidoc Co-Authored-By: benwtrent <ben.w.trent@gmail.com> * Update set-upgrade-mode.asciidoc * Update set-upgrade-mode.asciidoc
2019-01-30 07:51:11 -05:00
include::ml/set-upgrade-mode.asciidoc[]
[ML] Add high level REST client docs for ML put job endpoint (#32843) Relates #29827 Relates #32726
2018-08-14 14:52:54 -04:00
HLRC: migration get assistance API (#32744) The request and response classes have been extracted from `IndexUpgradeInfoAction` into top-level classes, and moved to the protocol jar. The `UpgradeActionRequired` enum is also moved. Relates to #29827
2018-08-13 05:05:27 -04:00
== Migration APIs
HLRC: Get Deprecation Info API (#36279) This commit adds the Get Deprecation Info API and associated documentation. Relates #29827
2018-12-07 09:22:21 -05:00
:upid: {mainid}-migration
:doc-tests-file: {doc-tests}/MigrationClientDocumentationIT.java
HLRC: migration get assistance API (#32744) The request and response classes have been extracted from `IndexUpgradeInfoAction` into top-level classes, and moved to the protocol jar. The `UpgradeActionRequired` enum is also moved. Relates to #29827
2018-08-13 05:05:27 -04:00
The Java High Level REST Client supports the following Migration APIs:
* <<java-rest-high-migration-get-assistance>>
HLRC: Get Deprecation Info API (#36279) This commit adds the Get Deprecation Info API and associated documentation. Relates #29827
2018-12-07 09:22:21 -05:00
* <<{upid}-upgrade>>
* <<{upid}-get-deprecation-info>>
HLRC: migration get assistance API (#32744) The request and response classes have been extracted from `IndexUpgradeInfoAction` into top-level classes, and moved to the protocol jar. The `UpgradeActionRequired` enum is also moved. Relates to #29827
2018-08-13 05:05:27 -04:00
include::migration/get-assistance.asciidoc[]
HLRC: migration api - upgrade (#34898) Implement high level client for migration upgrade API. It should wrap RestHighLevelClient and expose high level IndexUpgradeRequest (new), IndexTaskResponse for submissions with wait_for_completion=false and BulkByScrollResponse (already used) objects. refers: #29827
2018-11-13 09:01:53 -05:00
include::migration/upgrade.asciidoc[]
HLRC: Get Deprecation Info API (#36279) This commit adds the Get Deprecation Info API and associated documentation. Relates #29827
2018-12-07 09:22:21 -05:00
include::migration/get-deprecation-info.asciidoc[]
HLRC: migration get assistance API (#32744) The request and response classes have been extracted from `IndexUpgradeInfoAction` into top-level classes, and moved to the protocol jar. The `UpgradeActionRequired` enum is also moved. Relates to #29827
2018-08-13 05:05:27 -04:00
Add create rollup job api to high level rest client (#33521) This commit adds the Create Rollup Job API to the high level REST client. It supersedes #32703 and adds dedicated request/response objects so that it does not depend on server side components. Related #29827
2018-09-17 03:10:23 -04:00
== Rollup APIs
Add delete rollup job support to HL REST Client (#34066) Add support for delete rollup job to HL REST Client.
2018-10-16 09:02:29 -04:00
:upid: {mainid}-rollup
:doc-tests-file: {doc-tests}/RollupDocumentationIT.java
Add create rollup job api to high level rest client (#33521) This commit adds the Create Rollup Job API to the high level REST client. It supersedes #32703 and adds dedicated request/response objects so that it does not depend on server side components. Related #29827
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>>
Add start rollup job support to HL REST Client (#34623) This change adds support for starting a rollup job to High Level REST Client. Relates to #29827
2018-10-29 04:28:11 -04:00
* <<{upid}-rollup-start-job>>
Add stop rollup job support to HL REST Client (#34702) This change adds support for stoping a rollup job to the High Level REST Client. Relates to #29827
2018-11-13 23:40:42 -05:00
* <<{upid}-rollup-stop-job>>
Add delete rollup job support to HL REST Client (#34066) Add support for delete rollup job to HL REST Client.
2018-10-16 09:02:29 -04:00
* <<{upid}-rollup-delete-job>>
HLRC: Add get rollup job (#33921) Adds support for the get rollup job to the High Level REST Client. I had to do three interesting and unexpected things: 1. I ported the rollup state wiping code into the high level client tests. I'll move this into the test framework in a followup and remove the x-pack version. 2. The `timeout` in the rollup config was serialized using the `toString` representation of `TimeValue` which produces fractional time values which are more human readable but aren't supported by parsing. So I switched it to `getStringRep`. 3. Refactor the xcontent round trip testing utilities so we can test parsing of classes that don't implements `ToXContent`.
2018-10-02 09:11:29 -04:00
* <<java-rest-high-x-pack-rollup-get-job>>
HLRC: Add rollup search (#36334) Relates to #29827
2018-12-07 14:39:58 -05:00
* <<{upid}-search>>
Add GetRollupCaps API to high level rest client (#32880) Adds GetRollupCaps API to the HLRC, and tweaks some of the Caps objects to be immutable. Also various style tweaks
2018-10-18 17:12:38 -04:00
* <<{upid}-x-pack-rollup-get-rollup-caps>>
[HLRC] Add GetRollupIndexCaps API (#35102) Also refactors the caps response tests a bit to share the same abstract class to reduce duplication of test code
2018-11-12 15:05:03 -05:00
* <<{upid}-x-pack-rollup-get-rollup-index-caps>>
Add create rollup job api to high level rest client (#33521) This commit adds the Create Rollup Job API to the high level REST client. It supersedes #32703 and adds dedicated request/response objects so that it does not depend on server side components. Related #29827
2018-09-17 03:10:23 -04:00
include::rollup/put_job.asciidoc[]
Add start rollup job support to HL REST Client (#34623) This change adds support for starting a rollup job to High Level REST Client. Relates to #29827
2018-10-29 04:28:11 -04:00
include::rollup/start_job.asciidoc[]
Add stop rollup job support to HL REST Client (#34702) This change adds support for stoping a rollup job to the High Level REST Client. Relates to #29827
2018-11-13 23:40:42 -05:00
include::rollup/stop_job.asciidoc[]
Add delete rollup job support to HL REST Client (#34066) Add support for delete rollup job to HL REST Client.
2018-10-16 09:02:29 -04:00
include::rollup/delete_job.asciidoc[]
HLRC: Add get rollup job (#33921) Adds support for the get rollup job to the High Level REST Client. I had to do three interesting and unexpected things: 1. I ported the rollup state wiping code into the high level client tests. I'll move this into the test framework in a followup and remove the x-pack version. 2. The `timeout` in the rollup config was serialized using the `toString` representation of `TimeValue` which produces fractional time values which are more human readable but aren't supported by parsing. So I switched it to `getStringRep`. 3. Refactor the xcontent round trip testing utilities so we can test parsing of classes that don't implements `ToXContent`.
2018-10-02 09:11:29 -04:00
include::rollup/get_job.asciidoc[]
HLRC: Add rollup search (#36334) Relates to #29827
2018-12-07 14:39:58 -05:00
include::rollup/search.asciidoc[]
Add GetRollupCaps API to high level rest client (#32880) Adds GetRollupCaps API to the HLRC, and tweaks some of the Caps objects to be immutable. Also various style tweaks
2018-10-18 17:12:38 -04:00
include::rollup/get_rollup_caps.asciidoc[]
[HLRC] Add GetRollupIndexCaps API (#35102) Also refactors the caps response tests a bit to share the same abstract class to reduce duplication of test code
2018-11-12 15:05:03 -05:00
include::rollup/get_rollup_index_caps.asciidoc[]
Add create rollup job api to high level rest client (#33521) This commit adds the Create Rollup Job API to the high level REST client. It supersedes #32703 and adds dedicated request/response objects so that it does not depend on server side components. Related #29827
2018-09-17 03:10:23 -04:00
HLRC: add enable and disable user API support (#33481) This change adds support for enable and disable user APIs to the high level rest client. There is a common request base class for both requests with specific requests that simplify the use of these APIs. The response for these APIs is simply an empty object so a new response class has been created for cases where we expect an empty response to be returned. Finally, the put user documentation has been moved to the proper location that is not within an x-pack sub directory and the document tags no longer contain x-pack. See #29827
2018-09-07 13:51:37 -04:00
== Security APIs
HLRC: Delete role API (#34620) Adds the "Delete role" API to the high-level REST client.
2018-10-20 06:11:36 -04:00
:upid: {mainid}-security
:doc-tests-file: {doc-tests}/SecurityDocumentationIT.java
HLRC: add enable and disable user API support (#33481) This change adds support for enable and disable user APIs to the high level rest client. There is a common request base class for both requests with specific requests that simplify the use of these APIs. The response for these APIs is simply an empty object so a new response class has been created for cases where we expect an empty response to be returned. Finally, the put user documentation has been moved to the proper location that is not within an x-pack sub directory and the document tags no longer contain x-pack. See #29827
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>>
HLRC: Add get users action (#36332) This commit adds get user action to the high level rest client.
2018-12-13 13:24:48 -05:00
* <<{upid}-get-users>>
HLRC: Add delete user action (#35294) * HLRC: Add delete user action It adds delete user action to the high level rest client. Relates #29827
2018-11-29 01:52:56 -05:00
* <<{upid}-delete-user>>
HLRC: add enable and disable user API support (#33481) This change adds support for enable and disable user APIs to the high level rest client. There is a common request base class for both requests with specific requests that simplify the use of these APIs. The response for these APIs is simply an empty object so a new response class has been created for cases where we expect an empty response to be returned. Finally, the put user documentation has been moved to the proper location that is not within an x-pack sub directory and the document tags no longer contain x-pack. See #29827
2018-09-07 13:51:37 -04:00
* <<java-rest-high-security-enable-user>>
* <<java-rest-high-security-disable-user>>
Fix HLRC docs
2018-10-02 06:23:13 -04:00
* <<java-rest-high-security-change-password>>
[HLRC] Put Role (#36209) This commit adds support for the put role API in the java high level rest client.
2018-12-10 02:41:31 -05:00
* <<{upid}-put-role>>
[HLRC] Add support for get roles API (#35787) This commits adds support for the Get Roles API to the HLRC Relates: #29827
2018-11-26 04:25:07 -05:00
* <<{upid}-get-roles>>
HLRC: Delete role API (#34620) Adds the "Delete role" API to the high-level REST client.
2018-10-20 06:11:36 -04:00
* <<java-rest-high-security-delete-role>>
HLREST: Add Clear Roles Cache API (#34187) Adds support for the Clear Roles Cache API to the High Level Rest Client. As part of this a helper class, NodesResponseHeader, has been added that enables parsing the nodes header from responses that are node requests. Relates to #29827
2018-10-26 14:16:44 -04:00
* <<{upid}-clear-roles-cache>>
HLRC: add support for the clear realm cache API (#35163) This change adds support for clearing the cache of a realm. The realms cache may contain a stale set of credentials or incorrect role assignment, which can be corrected by clearing the cache of the entire realm or just that of a specific user. Relates #29827
2018-11-06 15:12:24 -05:00
* <<{upid}-clear-realm-cache>>
HLRest: add security authenticate API (#33552) This adds the security `_authenticate` API to the HLREST client. It is unlike some of the other APIs because the request does not have a body. The commit also creates the `User` entity. It is important to note that the `User` entity does not have the `enabled` flag. The `enabled` flag is part of the response, alongside the `User` entity. Moreover this adds the `SecurityIT` test class (extending `ESRestHighLevelClientTestCase`). Relates #29827
2018-10-31 08:49:33 -04:00
* <<{upid}-authenticate>>
HLRC: Add "_has_privileges" API to Security Client (#35479) This adds the "hasPrivileges()" method to SecurityClient, including request, response & async variant of the method. Also includes API documentation.
2018-11-15 21:52:06 -05:00
* <<{upid}-has-privileges>>
HLRC: Implement get-user-privileges API (#36292) This adds the _security/user/_privileges API to the High Level Rest Client. This also makes some changes to the Java model for the Role APIs in order to better accommodate the GetPrivileges API
2018-12-11 23:12:49 -05:00
* <<{upid}-get-user-privileges>>
HLRC: Get SSL Certificates API (#34135) This change adds support for the get SSL certificate API to the high level rest client.
2018-10-15 12:20:34 -04:00
* <<java-rest-high-security-get-certificates>>
HLRC: Create/Update role mapping API (#34171) We added support for role mapper expression DSL in #33745, that allows us to build the role mapper expression used in the role mapping (as rules for determining user roles based on what the boolean expression resolves to). This change now adds support for create/update role mapping API to the high-level rest client.
2018-10-15 22:05:46 -04:00
* <<java-rest-high-security-put-role-mapping>>
[DOCS] Fix typo in get role mappings API (#34952)
2018-10-28 20:15:42 -04:00
* <<java-rest-high-security-get-role-mappings>>
[HLRC] Add support for Delete role mapping API (#34531) Building on expression dsl and create role mapping API, this commit adds support for delete role mapping API to high level client.
2018-10-18 22:46:26 -04:00
* <<java-rest-high-security-delete-role-mapping>>
HLRC: Add security Create Token API (#34791) This adds the Create Token API (POST /_xpack/security/oauth2/token) to the High Level Rest Client. Relates: #29827
2018-10-29 02:17:56 -04:00
* <<java-rest-high-security-create-token>>
HLRC: Add InvalidateToken security API (#35114) This change adds the Invalidate Token API (DELETE /_xpack/security/oauth2/token) to the Elasticsearch High Level Rest Client. Relates: #29827
2018-11-05 23:26:12 -05:00
* <<{upid}-invalidate-token>>
[HLRC] Add support for get application privileges API (#35556) This commits adds support for the Get Application Privileges API to the HLRC Relates: #29827
2018-11-21 09:38:17 -05:00
* <<{upid}-get-privileges>>
[HLRC] Add support for put privileges API (#35679) This commit adds support for API to create or update application privileges in high-level rest client.
2018-12-09 00:03:28 -05:00
* <<{upid}-put-privileges>>
Add Delete Privileges API to HLRC (#35454) This commit adds the Delete Privileges API to the high level REST client. Related to #29827
2018-11-14 08:04:30 -05:00
* <<{upid}-delete-privileges>>
Add support for API keys to access Elasticsearch (#38291) X-Pack security supports built-in authentication service `token-service` that allows access tokens to be used to access Elasticsearch without using Basic authentication. The tokens are generated by `token-service` based on OAuth2 spec. The access token is a short-lived token (defaults to 20m) and refresh token with a lifetime of 24 hours, making them unsuitable for long-lived or recurring tasks where the system might go offline thereby failing refresh of tokens. This commit introduces a built-in authentication service `api-key-service` that adds support for long-lived tokens aka API keys to access Elasticsearch. The `api-key-service` is consulted after `token-service` in the authentication chain. By default, if TLS is enabled then `api-key-service` is also enabled. The service can be disabled using the configuration setting. The API keys:- - by default do not have an expiration but expiration can be configured where the API keys need to be expired after a certain amount of time. - when generated will keep authentication information of the user that generated them. - can be defined with a role describing the privileges for accessing Elasticsearch and will be limited by the role of the user that generated them - can be invalidated via invalidation API - information can be retrieved via a get API - that have been expired or invalidated will be retained for 1 week before being deleted. The expired API keys remover task handles this. Following are the API key management APIs:- 1. Create API Key - `PUT/POST /_security/api_key` 2. Get API key(s) - `GET /_security/api_key` 3. Invalidate API Key(s) `DELETE /_security/api_key` The API keys can be used to access Elasticsearch using `Authorization` header, where the auth scheme is `ApiKey` and the credentials, is the base64 encoding of API key Id and API key separated by a colon. Example:- ``` curl -H "Authorization: ApiKey YXBpLWtleS1pZDphcGkta2V5" http://localhost:9200/_cluster/health ``` Closes #34383
2019-02-04 22:21:57 -05:00
* <<{upid}-create-api-key>>
* <<{upid}-get-api-key>>
* <<{upid}-invalidate-api-key>>
HLRC: add enable and disable user API support (#33481) This change adds support for enable and disable user APIs to the high level rest client. There is a common request base class for both requests with specific requests that simplify the use of these APIs. The response for these APIs is simply an empty object so a new response class has been created for cases where we expect an empty response to be returned. Finally, the put user documentation has been moved to the proper location that is not within an x-pack sub directory and the document tags no longer contain x-pack. See #29827
2018-09-07 13:51:37 -04:00
include::security/put-user.asciidoc[]
HLRC: Add get users action (#36332) This commit adds get user action to the high level rest client.
2018-12-13 13:24:48 -05:00
include::security/get-users.asciidoc[]
HLRC: Add delete user action (#35294) * HLRC: Add delete user action It adds delete user action to the high level rest client. Relates #29827
2018-11-29 01:52:56 -05:00
include::security/delete-user.asciidoc[]
HLRC: add enable and disable user API support (#33481) This change adds support for enable and disable user APIs to the high level rest client. There is a common request base class for both requests with specific requests that simplify the use of these APIs. The response for these APIs is simply an empty object so a new response class has been created for cases where we expect an empty response to be returned. Finally, the put user documentation has been moved to the proper location that is not within an x-pack sub directory and the document tags no longer contain x-pack. See #29827
2018-09-07 13:51:37 -04:00
include::security/enable-user.asciidoc[]
include::security/disable-user.asciidoc[]
Fix HLRC docs
2018-10-02 06:23:13 -04:00
include::security/change-password.asciidoc[]
[HLRC] Put Role (#36209) This commit adds support for the put role API in the java high level rest client.
2018-12-10 02:41:31 -05:00
include::security/put-role.asciidoc[]
[DOCS] Fix missing include for get-roles
2018-11-26 04:45:03 -05:00
include::security/get-roles.asciidoc[]
HLRC: Delete role API (#34620) Adds the "Delete role" API to the high-level REST client.
2018-10-20 06:11:36 -04:00
include::security/delete-role.asciidoc[]
Add Delete Privileges API to HLRC (#35454) This commit adds the Delete Privileges API to the high level REST client. Related to #29827
2018-11-14 08:04:30 -05:00
include::security/delete-privileges.asciidoc[]
[HLRC] Add support for get application privileges API (#35556) This commits adds support for the Get Application Privileges API to the HLRC Relates: #29827
2018-11-21 09:38:17 -05:00
include::security/get-privileges.asciidoc[]
HLREST: Add Clear Roles Cache API (#34187) Adds support for the Clear Roles Cache API to the High Level Rest Client. As part of this a helper class, NodesResponseHeader, has been added that enables parsing the nodes header from responses that are node requests. Relates to #29827
2018-10-26 14:16:44 -04:00
include::security/clear-roles-cache.asciidoc[]
HLRC: add support for the clear realm cache API (#35163) This change adds support for clearing the cache of a realm. The realms cache may contain a stale set of credentials or incorrect role assignment, which can be corrected by clearing the cache of the entire realm or just that of a specific user. Relates #29827
2018-11-06 15:12:24 -05:00
include::security/clear-realm-cache.asciidoc[]
HLRest: add security authenticate API (#33552) This adds the security `_authenticate` API to the HLREST client. It is unlike some of the other APIs because the request does not have a body. The commit also creates the `User` entity. It is important to note that the `User` entity does not have the `enabled` flag. The `enabled` flag is part of the response, alongside the `User` entity. Moreover this adds the `SecurityIT` test class (extending `ESRestHighLevelClientTestCase`). Relates #29827
2018-10-31 08:49:33 -04:00
include::security/authenticate.asciidoc[]
HLRC: Add "_has_privileges" API to Security Client (#35479) This adds the "hasPrivileges()" method to SecurityClient, including request, response & async variant of the method. Also includes API documentation.
2018-11-15 21:52:06 -05:00
include::security/has-privileges.asciidoc[]
HLRC: Implement get-user-privileges API (#36292) This adds the _security/user/_privileges API to the High Level Rest Client. This also makes some changes to the Java model for the Role APIs in order to better accommodate the GetPrivileges API
2018-12-11 23:12:49 -05:00
include::security/get-user-privileges.asciidoc[]
HLRC: Get SSL Certificates API (#34135) This change adds support for the get SSL certificate API to the high level rest client.
2018-10-15 12:20:34 -04:00
include::security/get-certificates.asciidoc[]
HLRC: Create/Update role mapping API (#34171) We added support for role mapper expression DSL in #33745, that allows us to build the role mapper expression used in the role mapping (as rules for determining user roles based on what the boolean expression resolves to). This change now adds support for create/update role mapping API to the high-level rest client.
2018-10-15 22:05:46 -04:00
include::security/put-role-mapping.asciidoc[]
[DOCS] Fix typo in get role mappings API (#34952)
2018-10-28 20:15:42 -04:00
include::security/get-role-mappings.asciidoc[]
[HLRC] Add support for Delete role mapping API (#34531) Building on expression dsl and create role mapping API, this commit adds support for delete role mapping API to high level client.
2018-10-18 22:46:26 -04:00
include::security/delete-role-mapping.asciidoc[]
HLRC: Add security Create Token API (#34791) This adds the Create Token API (POST /_xpack/security/oauth2/token) to the High Level Rest Client. Relates: #29827
2018-10-29 02:17:56 -04:00
include::security/create-token.asciidoc[]
HLRC: Add InvalidateToken security API (#35114) This change adds the Invalidate Token API (DELETE /_xpack/security/oauth2/token) to the Elasticsearch High Level Rest Client. Relates: #29827
2018-11-05 23:26:12 -05:00
include::security/invalidate-token.asciidoc[]
[HLRC] Add support for put privileges API (#35679) This commit adds support for API to create or update application privileges in high-level rest client.
2018-12-09 00:03:28 -05:00
include::security/put-privileges.asciidoc[]
Add support for API keys to access Elasticsearch (#38291) X-Pack security supports built-in authentication service `token-service` that allows access tokens to be used to access Elasticsearch without using Basic authentication. The tokens are generated by `token-service` based on OAuth2 spec. The access token is a short-lived token (defaults to 20m) and refresh token with a lifetime of 24 hours, making them unsuitable for long-lived or recurring tasks where the system might go offline thereby failing refresh of tokens. This commit introduces a built-in authentication service `api-key-service` that adds support for long-lived tokens aka API keys to access Elasticsearch. The `api-key-service` is consulted after `token-service` in the authentication chain. By default, if TLS is enabled then `api-key-service` is also enabled. The service can be disabled using the configuration setting. The API keys:- - by default do not have an expiration but expiration can be configured where the API keys need to be expired after a certain amount of time. - when generated will keep authentication information of the user that generated them. - can be defined with a role describing the privileges for accessing Elasticsearch and will be limited by the role of the user that generated them - can be invalidated via invalidation API - information can be retrieved via a get API - that have been expired or invalidated will be retained for 1 week before being deleted. The expired API keys remover task handles this. Following are the API key management APIs:- 1. Create API Key - `PUT/POST /_security/api_key` 2. Get API key(s) - `GET /_security/api_key` 3. Invalidate API Key(s) `DELETE /_security/api_key` The API keys can be used to access Elasticsearch using `Authorization` header, where the auth scheme is `ApiKey` and the credentials, is the base64 encoding of API key Id and API key separated by a colon. Example:- ``` curl -H "Authorization: ApiKey YXBpLWtleS1pZDphcGkta2V5" http://localhost:9200/_cluster/health ``` Closes #34383
2019-02-04 22:21:57 -05:00
include::security/create-api-key.asciidoc[]
include::security/get-api-key.asciidoc[]
include::security/invalidate-api-key.asciidoc[]
HLRC: add enable and disable user API support (#33481) This change adds support for enable and disable user APIs to the high level rest client. There is a common request base class for both requests with specific requests that simplify the use of these APIs. The response for these APIs is simply an empty object so a new response class has been created for cases where we expect an empty response to be returned. Finally, the put user documentation has been moved to the proper location that is not within an x-pack sub directory and the document tags no longer contain x-pack. See #29827
2018-09-07 13:51:37 -04:00
[DOCS] Adjust high-level client x-pack docs (#32747) - Expose x-pack usage docs page which was not linked in supported-apis page - make watcher a top-level dir outside of x-pack directory - move x-pack info and usage pages to miscellaneous - add new Watcher category to supported-apis (they were under miscellaneous) - remove x-pack prefix from watcher docs titles
2018-08-10 08:12:42 -04:00
== Watcher APIs
Small fixes to the HLRC watcher documentation. (#34306) * Make sure to use the new docs style for 'ack watch'. * Replace 'document' with 'watcher' in page names.
2018-10-04 17:30:20 -04:00
:upid: {mainid}-watcher
HLRC: Add activate watch action (#33988) * HLRC: Add activate watcher action Adds activate watch action to the high level rest client. Relates #29827
2018-10-04 06:49:52 -04:00
:doc-tests-file: {doc-tests}/WatcherDocumentationIT.java
[DOCS] Adjust high-level client x-pack docs (#32747) - Expose x-pack usage docs page which was not linked in supported-apis page - make watcher a top-level dir outside of x-pack directory - move x-pack info and usage pages to miscellaneous - add new Watcher category to supported-apis (they were under miscellaneous) - remove x-pack prefix from watcher docs titles
2018-08-10 08:12:42 -04:00
The Java High Level REST Client supports the following Watcher APIs:
[Docs] Fixes a bug in the rest-client watcher docs related to cross-link issue.
2018-10-19 14:52:15 -04:00
* <<{upid}-start-watch-service>>
* <<{upid}-stop-watch-service>>
[DOCS] Adjust high-level client x-pack docs (#32747) - Expose x-pack usage docs page which was not linked in supported-apis page - make watcher a top-level dir outside of x-pack directory - move x-pack info and usage pages to miscellaneous - add new Watcher category to supported-apis (they were under miscellaneous) - remove x-pack prefix from watcher docs titles
2018-08-10 08:12:42 -04:00
* <<java-rest-high-x-pack-watcher-put-watch>>
[TEST] fix link in get-watch documentation
2018-11-30 08:40:09 -05:00
* <<{upid}-get-watch>>
[DOCS] Adjust high-level client x-pack docs (#32747) - Expose x-pack usage docs page which was not linked in supported-apis page - make watcher a top-level dir outside of x-pack directory - move x-pack info and usage pages to miscellaneous - add new Watcher category to supported-apis (they were under miscellaneous) - remove x-pack prefix from watcher docs titles
2018-08-10 08:12:42 -04:00
* <<java-rest-high-x-pack-watcher-delete-watch>>
HLRC: Deactivate Watch API (#34192) Relates to #29827
2018-10-24 17:01:22 -04:00
* <<java-rest-high-watcher-deactivate-watch>>
Small fixes to the HLRC watcher documentation. (#34306) * Make sure to use the new docs style for 'ack watch'. * Replace 'document' with 'watcher' in page names.
2018-10-04 17:30:20 -04:00
* <<{upid}-ack-watch>>
HLRC: Add activate watch action (#33988) * HLRC: Add activate watcher action Adds activate watch action to the high level rest client. Relates #29827
2018-10-04 06:49:52 -04:00
* <<{upid}-activate-watch>>
HLRC: execute watch API (#35868) This change adds support for the execute watch API in the high level rest client
2018-12-05 07:41:42 -05:00
* <<{upid}-execute-watch>>
Rest HL client: Add watcher stats API (#35185) Relates to #29827
2018-11-13 09:47:35 -05:00
* <<{upid}-watcher-stats>>
[DOCS] Adjust high-level client x-pack docs (#32747) - Expose x-pack usage docs page which was not linked in supported-apis page - make watcher a top-level dir outside of x-pack directory - move x-pack info and usage pages to miscellaneous - add new Watcher category to supported-apis (they were under miscellaneous) - remove x-pack prefix from watcher docs titles
2018-08-10 08:12:42 -04:00
[HLRC] Add Start/Stop Watch Service APIs. (#34317)
2018-10-19 12:42:57 -04:00
include::watcher/start-watch-service.asciidoc[]
include::watcher/stop-watch-service.asciidoc[]
[DOCS] Adjust high-level client x-pack docs (#32747) - Expose x-pack usage docs page which was not linked in supported-apis page - make watcher a top-level dir outside of x-pack directory - move x-pack info and usage pages to miscellaneous - add new Watcher category to supported-apis (they were under miscellaneous) - remove x-pack prefix from watcher docs titles
2018-08-10 08:12:42 -04:00
include::watcher/put-watch.asciidoc[]
HLRC: Add get watch API (#35531) This changes adds the support for the get watch API in the high level rest client.
2018-11-30 05:02:46 -05:00
include::watcher/get-watch.asciidoc[]
[DOCS] Adjust high-level client x-pack docs (#32747) - Expose x-pack usage docs page which was not linked in supported-apis page - make watcher a top-level dir outside of x-pack directory - move x-pack info and usage pages to miscellaneous - add new Watcher category to supported-apis (they were under miscellaneous) - remove x-pack prefix from watcher docs titles
2018-08-10 08:12:42 -04:00
include::watcher/delete-watch.asciidoc[]
Add support for 'ack watch' to the HLRC. (#33962)
2018-10-03 05:03:03 -04:00
include::watcher/ack-watch.asciidoc[]
HLRC: Deactivate Watch API (#34192) Relates to #29827
2018-10-24 17:01:22 -04:00
include::watcher/deactivate-watch.asciidoc[]
HLRC: Add activate watch action (#33988) * HLRC: Add activate watcher action Adds activate watch action to the high level rest client. Relates #29827
2018-10-04 06:49:52 -04:00
include::watcher/activate-watch.asciidoc[]
HLRC: execute watch API (#35868) This change adds support for the execute watch API in the high level rest client
2018-12-05 07:41:42 -05:00
include::watcher/execute-watch.asciidoc[]
Rest HL client: Add watcher stats API (#35185) Relates to #29827
2018-11-13 09:47:35 -05:00
include::watcher/watcher-stats.asciidoc[]
HLRC GraphClient and associated tests (#32366) GraphClient for the high level REST client and associated tests. Part of #29827 work
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[]
Docs: Cut down on high level rest client copy-and-paste-ness (#34125) * Anchors * includes * get settings * more * More
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!:
HLRest: add security authenticate API (#33552) This adds the security `_authenticate` API to the HLREST client. It is unlike some of the other APIs because the request does not have a body. The commit also creates the `User` entity. It is important to note that the `User` entity does not have the `enabled` flag. The `enabled` flag is part of the response, alongside the `User` entity. Moreover this adds the `SecurityIT` test class (extending `ESRestHighLevelClientTestCase`). Relates #29827
2018-10-31 08:49:33 -04:00
--
[CCR] Added HLRC support for pause follow API (#35216) * Moved `AcknowledgedResponse` to core package * Made AcknowledgedResponse not abstract and provided a default parser, so that in cases when the field name is not overwritten then there is no need for a subclass. Relates to #33824
2018-11-07 11:08:35 -05:00
== CCR APIs
:upid: {mainid}-ccr
:doc-tests-file: {doc-tests}/CCRDocumentationIT.java
The Java High Level REST Client supports the following CCR APIs:
[HLRC] Added support for CCR Put Follow API (#35409) This change also adds documentation for the Put Follow API and adds a CCR HLRC integration test.
2018-11-13 07:22:49 -05:00
* <<{upid}-ccr-put-follow>>
[CCR] Added HLRC support for pause follow API (#35216) * Moved `AcknowledgedResponse` to core package * Made AcknowledgedResponse not abstract and provided a default parser, so that in cases when the field name is not overwritten then there is no need for a subclass. Relates to #33824
2018-11-07 11:08:35 -05:00
* <<{upid}-ccr-pause-follow>>
[HLRC] Added support for CCR Resume Follow API (#35638) This change also adds documentation for the Resume Follow API Relates to #33824
2018-11-21 04:52:03 -05:00
* <<{upid}-ccr-resume-follow>>
[HLRC] Added support for CCR Unfollow API (#35693) This change also adds documentation for the Unfollow API Relates to #33824
2018-11-21 01:48:29 -05:00
* <<{upid}-ccr-unfollow>>
[HLRC] Added support for CCR Put Auto Follow Pattern API (#35780) This change also adds documentation for the Put Auto Follow Pattern API. Relates to #33824
2018-11-27 02:53:22 -05:00
* <<{upid}-ccr-put-auto-follow-pattern>>
[HLRC] Added support for CCR Delete Auto Follow Pattern API (#35981) This change also adds documentation for the Delete Auto Follow Pattern API. Relates to #33824
2018-11-29 02:06:31 -05:00
* <<{upid}-ccr-delete-auto-follow-pattern>>
[HLRC] Added support for CCR Get Auto Follow Pattern apis (#36049) This change also adds documentation for the Get Auto Follow Pattern API. Relates to #33824
2018-12-04 01:41:29 -05:00
* <<{upid}-ccr-get-auto-follow-pattern>>
[HLRC] Added support for CCR Stats API (#36213) This change also adds documentation for the CCR Stats API. Relates to #33824
2018-12-05 07:14:51 -05:00
* <<{upid}-ccr-get-stats>>
[HLRC] Added support for Follow Stats API (#36253) This change also adds documentation for the Follow Stats API. Relates to #33824
2018-12-09 13:59:08 -05:00
* <<{upid}-ccr-get-follow-stats>>
[CCR] Added HLRC support for pause follow API (#35216) * Moved `AcknowledgedResponse` to core package * Made AcknowledgedResponse not abstract and provided a default parser, so that in cases when the field name is not overwritten then there is no need for a subclass. Relates to #33824
2018-11-07 11:08:35 -05:00
[HLRC] Added support for CCR Put Follow API (#35409) This change also adds documentation for the Put Follow API and adds a CCR HLRC integration test.
2018-11-13 07:22:49 -05:00
include::ccr/put_follow.asciidoc[]
[CCR] Added HLRC support for pause follow API (#35216) * Moved `AcknowledgedResponse` to core package * Made AcknowledgedResponse not abstract and provided a default parser, so that in cases when the field name is not overwritten then there is no need for a subclass. Relates to #33824
2018-11-07 11:08:35 -05:00
include::ccr/pause_follow.asciidoc[]
[HLRC] Added support for CCR Resume Follow API (#35638) This change also adds documentation for the Resume Follow API Relates to #33824
2018-11-21 04:52:03 -05:00
include::ccr/resume_follow.asciidoc[]
[HLRC] Added support for CCR Unfollow API (#35693) This change also adds documentation for the Unfollow API Relates to #33824
2018-11-21 01:48:29 -05:00
include::ccr/unfollow.asciidoc[]
[HLRC] Added support for CCR Put Auto Follow Pattern API (#35780) This change also adds documentation for the Put Auto Follow Pattern API. Relates to #33824
2018-11-27 02:53:22 -05:00
include::ccr/put_auto_follow_pattern.asciidoc[]
[HLRC] Added support for CCR Delete Auto Follow Pattern API (#35981) This change also adds documentation for the Delete Auto Follow Pattern API. Relates to #33824
2018-11-29 02:06:31 -05:00
include::ccr/delete_auto_follow_pattern.asciidoc[]
[HLRC] Added support for CCR Get Auto Follow Pattern apis (#36049) This change also adds documentation for the Get Auto Follow Pattern API. Relates to #33824
2018-12-04 01:41:29 -05:00
include::ccr/get_auto_follow_pattern.asciidoc[]
[HLRC] Added support for CCR Stats API (#36213) This change also adds documentation for the CCR Stats API. Relates to #33824
2018-12-05 07:14:51 -05:00
include::ccr/get_stats.asciidoc[]
[HLRC] Added support for Follow Stats API (#36253) This change also adds documentation for the Follow Stats API. Relates to #33824
2018-12-09 13:59:08 -05:00
include::ccr/get_follow_stats.asciidoc[]
Adds HLRC docs for put lifecycle policy (#35457) * Adds HLRC docs for put lifecycle policy * Adds link to docs in client javadocs * Fixes checkstyle * Make the documentation use the right ack response
2018-11-13 15:40:53 -05:00
== Index Lifecycle Management APIs
:upid: {mainid}-ilm
:doc-tests-file: {doc-tests}/ILMDocumentationIT.java
The Java High Level REST Client supports the following Index Lifecycle
Management APIs:
* <<{upid}-ilm-put-lifecycle-policy>>
Add HLRC docs for Delete Lifecycle Policy (#35664) Adds documenatation for the Delete Lifecycle Policy API to the HLRC documentation.
2018-11-20 13:32:41 -05:00
* <<{upid}-ilm-delete-lifecycle-policy>>
Add HLRC docs for Get Lifecycle Policy (#35612) Adds docs for the Get Lifecycle Policy API to the HLRC documentation.
2018-11-16 20:16:30 -05:00
* <<{upid}-ilm-get-lifecycle-policy>>
Add HLRC docs for Explain Lifecycle (#35803) Adds HLRC documentation for the Explain Lifecycle API.
2018-11-26 17:25:56 -05:00
* <<{upid}-ilm-explain-lifecycle>>
Add HLRC docs for ILM Start/Stop/Status (#35672) Adds HLRC documentation for Start ILM, Stop ILM, and ILM Status APIs, as these APIs are tightly linked to each other.
2018-11-19 19:17:01 -05:00
* <<{upid}-ilm-start-ilm>>
* <<{upid}-ilm-stop-ilm>>
* <<{upid}-ilm-status>>
[ILM] HLRC-ILM Retry Lifecycle Policy docs (#35715) this adds documentation for the retry method in the high-level-ilm-rest-client. this PR also renames retryLifecycleStep to retryLifecyclePolicy in the index-lifecycle-client
2018-11-20 10:05:27 -05:00
* <<{upid}-ilm-retry-lifecycle-policy>>
[ILM] add HLRC docs to remove-policy-from-index (#35759) This primarily introduces documentation for the HLRC remove-policy-from-index action.
2018-11-27 16:28:58 -05:00
* <<{upid}-ilm-remove-lifecycle-policy-from-index>>
Add HLRC docs for ILM Start/Stop/Status (#35672) Adds HLRC documentation for Start ILM, Stop ILM, and ILM Status APIs, as these APIs are tightly linked to each other.
2018-11-19 19:17:01 -05:00
Adds HLRC docs for put lifecycle policy (#35457) * Adds HLRC docs for put lifecycle policy * Adds link to docs in client javadocs * Fixes checkstyle * Make the documentation use the right ack response
2018-11-13 15:40:53 -05:00
include::ilm/put_lifecycle_policy.asciidoc[]
Add HLRC docs for Delete Lifecycle Policy (#35664) Adds documenatation for the Delete Lifecycle Policy API to the HLRC documentation.
2018-11-20 13:32:41 -05:00
include::ilm/delete_lifecycle_policy.asciidoc[]
Add HLRC docs for Get Lifecycle Policy (#35612) Adds docs for the Get Lifecycle Policy API to the HLRC documentation.
2018-11-16 20:16:30 -05:00
include::ilm/get_lifecycle_policy.asciidoc[]
Add HLRC docs for Explain Lifecycle (#35803) Adds HLRC documentation for the Explain Lifecycle API.
2018-11-26 17:25:56 -05:00
include::ilm/explain_lifecycle.asciidoc[]
Add HLRC docs for ILM Start/Stop/Status (#35672) Adds HLRC documentation for Start ILM, Stop ILM, and ILM Status APIs, as these APIs are tightly linked to each other.
2018-11-19 19:17:01 -05:00
include::ilm/start_lifecycle_management.asciidoc[]
include::ilm/stop_lifecycle_management.asciidoc[]
[ILM] HLRC-ILM Retry Lifecycle Policy docs (#35715) this adds documentation for the retry method in the high-level-ilm-rest-client. this PR also renames retryLifecycleStep to retryLifecyclePolicy in the index-lifecycle-client
2018-11-20 10:05:27 -05:00
include::ilm/lifecycle_management_status.asciidoc[]
include::ilm/retry_lifecycle_policy.asciidoc[]
[ILM] add HLRC docs to remove-policy-from-index (#35759) This primarily introduces documentation for the HLRC remove-policy-from-index action.
2018-11-27 16:28:58 -05:00
include::ilm/remove_lifecycle_policy_from_index.asciidoc[]