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_mappings.asciidoc

52 lines
1.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-mappings
:request: GetMappingsRequest
:response: GetMappingsResponse
--
[id="{upid}-{api}"]
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
=== Get Mappings 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 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
==== Get Mappings Request
Support both typed and typeless 'get mapping' requests in the HLRC. (#37796) From previous PRs, we've already added support for include_type_name to the get mapping API. We had also taken an approach to the HLRC where the server-side `GetMappingResponse#fromXContent` could only handle typeless input. This PR updates the HLRC for 'get mapping' to be in line with our new approach: * Add a typeless 'get mappings' method to the Java HLRC, that accepts new client-side request and response objects. This new response only handles typeless mapping definitions. * Switch the old version of `GetMappingResponse` back to expecting typed mappings, and deprecate the corresponding method on the HLRC. Finally, the PR also does some small, related clean-up around 'get field mappings'.
2019-01-27 19:02:22 -05:00
A +{request}+ can have an optional list of indices:
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
["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 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
--------------------------------------------------
Support both typed and typeless 'get mapping' requests in the HLRC. (#37796) From previous PRs, we've already added support for include_type_name to the get mapping API. We had also taken an approach to the HLRC where the server-side `GetMappingResponse#fromXContent` could only handle typeless input. This PR updates the HLRC for 'get mapping' to be in line with our new approach: * Add a typeless 'get mappings' method to the Java HLRC, that accepts new client-side request and response objects. This new response only handles typeless mapping definitions. * Switch the old version of `GetMappingResponse` back to expecting typed mappings, and deprecate the corresponding method on the HLRC. Finally, the PR also does some small, related clean-up around 'get field mappings'.
2019-01-27 19:02:22 -05:00
<1> An empty request that will return all indices
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
<2> Setting the indices to fetch mapping for
==== Optional arguments
The following arguments can also 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-masterTimeout]
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
--------------------------------------------------
<1> Timeout to connect to the master node as a `TimeValue`
["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 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
--------------------------------------------------
<1> Options for expanding indices names
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 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
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 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
==== Get Mappings 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 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
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 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
--------------------------------------------------
<1> Returning all indices' mappings
Support both typed and typeless 'get mapping' requests in the HLRC. (#37796) From previous PRs, we've already added support for include_type_name to the get mapping API. We had also taken an approach to the HLRC where the server-side `GetMappingResponse#fromXContent` could only handle typeless input. This PR updates the HLRC for 'get mapping' to be in line with our new approach: * Add a typeless 'get mappings' method to the Java HLRC, that accepts new client-side request and response objects. This new response only handles typeless mapping definitions. * Switch the old version of `GetMappingResponse` back to expecting typed mappings, and deprecate the corresponding method on the HLRC. Finally, the PR also does some small, related clean-up around 'get field mappings'.
2019-01-27 19:02:22 -05:00
<2> Retrieving the mappings for a particular index
Make sure to use the type _doc in the REST documentation. (#34662) * Replace custom type names with _doc in REST examples. * Avoid using two mapping types in the percolator docs. * Rename doc -> _doc in the main repository README. * Also replace some custom type names in the HLRC docs.
2018-10-22 14:54:04 -04:00
<3> Getting the mappings as a Java Map