Update mapping API
editUpdate mapping API
editAdds new fields to an existing data stream or index. You can also use the API to change the search settings of existing fields.
Request
editA PutMappingRequest requires an index argument:
Mapping source
editA description of the fields to create on the mapping; if not defined, the mapping will default to empty.
Providing the mapping source
editThe mapping source can be provided in different ways in addition to
the String example shown above:
Map<String, Object> jsonMap = new HashMap<>();
Map<String, Object> message = new HashMap<>();
message.put("type", "text");
Map<String, Object> properties = new HashMap<>();
properties.put("message", message);
jsonMap.put("properties", properties);
request.source(jsonMap);
Optional arguments
editThe following arguments can optionally be provided:
Synchronous execution
editWhen executing a PutMappingRequest in the following manner, the client waits
for the PutMappingResponse to be returned before continuing with code execution:
AcknowledgedResponse putMappingResponse = client.indices().putMapping(request, RequestOptions.DEFAULT);
Synchronous calls may throw an IOException in case of either failing to
parse the REST response in the high-level REST client, the request times out
or similar cases where there is no response coming back from the server.
In cases where the server returns a 4xx or 5xx error code, the high-level
client tries to parse the response body error details instead and then throws
a generic ElasticsearchException and adds the original ResponseException as a
suppressed exception to it.
Asynchronous execution
editExecuting a PutMappingRequest can also be done in an asynchronous fashion so that
the client can return directly. Users need to specify how the response or
potential failures will be handled by passing the request and a listener to the
asynchronous put-mapping method:
The asynchronous method does not block and returns immediately. Once it is
completed the ActionListener is called back using the onResponse method
if the execution successfully completed or using the onFailure method if
it failed. Failure scenarios and expected exceptions are the same as in the
synchronous execution case.
A typical listener for put-mapping looks like:
Response
editThe returned PutMappingResponse allows to retrieve information about the executed
operation as follows: