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/indices/close_index.asciidoc

60 lines
2.0 KiB
Plaintext
Raw Normal View History

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
--
:api: close-index
:request: CloseIndexRequest
:response: CloseIndexResponse
--
[id="{upid}-{api}"]
Add Close Index API to the high level REST client (#27734) Add support for _close endpoint to the high level REST client Relates to #27205
2018-01-17 05:47:08 -05:00
=== Close Index API
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
[id="{upid}-{api}-request"]
Add Close Index API to the high level REST client (#27734) Add support for _close endpoint to the high level REST client Relates to #27205
2018-01-17 05:47:08 -05:00
==== Close Index Request
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
A +{request}+ requires an `index` argument:
Add Close Index API to the high level REST client (#27734) Add support for _close endpoint to the high level REST client Relates to #27205
2018-01-17 05:47:08 -05:00
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
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
include-tagged::{doc-tests-file}[{api}-request]
Add Close Index API to the high level REST client (#27734) Add support for _close endpoint to the high level REST client Relates to #27205
2018-01-17 05:47:08 -05:00
--------------------------------------------------
<1> The index to close
==== Optional arguments
The following arguments can optionally be provided:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
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
include-tagged::{doc-tests-file}[{api}-request-timeout]
Add Close Index API to the high level REST client (#27734) Add support for _close endpoint to the high level REST client Relates to #27205
2018-01-17 05:47:08 -05:00
--------------------------------------------------
<1> Timeout to wait for the all the nodes to acknowledge the index is closed
as a `TimeValue`
<2> Timeout to wait for the all the nodes to acknowledge the index is closed
as a `String`
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
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
include-tagged::{doc-tests-file}[{api}-request-masterTimeout]
Add Close Index API to the high level REST client (#27734) Add support for _close endpoint to the high level REST client Relates to #27205
2018-01-17 05:47:08 -05:00
--------------------------------------------------
<1> Timeout to connect to the master node as a `TimeValue`
<2> Timeout to connect to the master node as a `String`
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
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
include-tagged::{doc-tests-file}[{api}-request-indicesOptions]
Add Close Index API to the high level REST client (#27734) Add support for _close endpoint to the high level REST client Relates to #27205
2018-01-17 05:47:08 -05:00
--------------------------------------------------
<1> Setting `IndicesOptions` controls how unavailable indices are resolved and
how wildcard expressions are expanded
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
include::../execution.asciidoc[]
Add Close Index API to the high level REST client (#27734) Add support for _close endpoint to the high level REST client Relates to #27205
2018-01-17 05:47:08 -05:00
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
[id="{upid}-{api}-response"]
Add Close Index API to the high level REST client (#27734) Add support for _close endpoint to the high level REST client Relates to #27205
2018-01-17 05:47:08 -05:00
==== Close Index Response
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
The returned +{response}+ allows to retrieve information about the
Add Close Index API to the high level REST client (#27734) Add support for _close endpoint to the high level REST client Relates to #27205
2018-01-17 05:47:08 -05:00
executed operation as follows:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
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
include-tagged::{doc-tests-file}[{api}-response]
Add Close Index API to the high level REST client (#27734) Add support for _close endpoint to the high level REST client Relates to #27205
2018-01-17 05:47:08 -05:00
--------------------------------------------------
<1> Indicates whether all of the nodes have acknowledged the request