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/get_settings.asciidoc

68 lines
2.6 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: get-settings
:request: GetSettingsRequest
:response: GetSettingsResponse
--
[id="{upid}-{api}"]
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
=== Get Settings 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 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
==== Get Settings 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 one or more `index` arguments:
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
["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 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
--------------------------------------------------
<1> The index whose settings we should retrieve
==== 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-names]
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
--------------------------------------------------
<1> One or more settings that be the only settings retrieved. If unset, all settings will be retrieved
["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-include-defaults]
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
--------------------------------------------------
<1> If true, defaults will be returned for settings not explicitly set on the index
["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 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
--------------------------------------------------
<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 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
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 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
==== Get Settings 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 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
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 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
--------------------------------------------------
<1> We can retrieve the setting value for a particular index directly from the response as a string
<2> We can also retrieve the Settings object for a particular index for further examination
<3> The returned Settings object provides convenience methods for non String types
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
If the `includeDefaults` flag was set to true in the +{request}+ the
behavior of +{response}+ will differ somewhat.
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
["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}-defaults-response]
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
--------------------------------------------------
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
<1> Individual default setting values may be retrieved directly from the +{response}+
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
<2> We may retrieve a Settings object for an index that contains those settings with default values