72 lines
3.0 KiB
Plaintext
72 lines
3.0 KiB
Plaintext
|
[[java-rest-high-put-mapping]]
|
||
|
|
=== Put Mapping API
|
||
|
|
|
||
|
|
[[java-rest-high-put-mapping-request]]
|
||
|
|
==== Put Mapping Request
|
||
|
|
|
||
|
|
A `PutMappingRequest` requires an `index` argument, and a type:
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-mapping-request]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> The index to add the mapping to
|
||
|
|
<2> The type to create (or update)
|
||
|
|
|
||
|
|
==== Mapping source
|
||
|
|
A description of the fields to create on the mapping; if not defined, the mapping will default to empty.
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-mapping-request-source]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> The mapping source
|
||
|
|
|
||
|
|
==== Optional arguments
|
||
|
|
The following arguments can optionally be provided:
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-mapping-request-timeout]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Timeout to wait for the all the nodes to acknowledge the index creation as a `TimeValue`
|
||
|
|
<2> Timeout to wait for the all the nodes to acknowledge the index creation as a `String`
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-mapping-request-masterTimeout]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Timeout to connect to the master node as a `TimeValue`
|
||
|
|
<2> Timeout to connect to the master node as a `String`
|
||
|
|
|
||
|
|
[[java-rest-high-put-mapping-sync]]
|
||
|
|
==== Synchronous Execution
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-mapping-execute]
|
||
|
|
--------------------------------------------------
|
||
|
|
|
||
|
|
[[java-rest-high-put-mapping-async]]
|
||
|
|
==== Asynchronous Execution
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-mapping-execute-async]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Called when the execution is successfully completed. The response is
|
||
|
|
provided as an argument
|
||
|
|
<2> Called in case of failure. The raised exception is provided as an argument
|
||
|
|
|
||
|
|
[[java-rest-high-put-mapping-response]]
|
||
|
|
==== Put Mapping Response
|
||
|
|
|
||
|
|
The returned `PutMappingResponse` allows to retrieve information about the executed
|
||
|
|
operation as follows:
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-mapping-response]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Indicates whether all of the nodes have acknowledged the request
|