Put Mapping API

Put Mapping Request

A PutMappingRequest requires an index argument:

PutMappingRequest request = new PutMappingRequest("twitter"); 

The index to add the mapping to

Mapping source

A description of the fields to create on the mapping; if not defined, the mapping will default to empty.

request.source(
    "{\n" +
    "  \"properties\": {\n" +
    "    \"message\": {\n" +
    "      \"type\": \"text\"\n" +
    "    }\n" +
    "  }\n" +
    "}", 
    XContentType.JSON);

Mapping source provided as a String

Providing the mapping source

The 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); 

Mapping source provided as a Map which gets automatically converted to JSON format

XContentBuilder builder = XContentFactory.jsonBuilder();
builder.startObject();
{
    builder.startObject("properties");
    {
        builder.startObject("message");
        {
            builder.field("type", "text");
        }
        builder.endObject();
    }
    builder.endObject();
}
builder.endObject();
request.source(builder); 

Mapping source provided as an XContentBuilder object, the Elasticsearch built-in helpers to generate JSON content

Optional arguments

The following arguments can optionally be provided:

request.setTimeout(TimeValue.timeValueMinutes(2)); 

Timeout to wait for the all the nodes to acknowledge the index creation as a TimeValue

request.setMasterTimeout(TimeValue.timeValueMinutes(1)); 

Timeout to connect to the master node as a TimeValue

Synchronous Execution

When 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

Executing 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:

client.indices().putMappingAsync(request, RequestOptions.DEFAULT, listener); 

The PutMappingRequest to execute and the ActionListener to use when the execution completes

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:

ActionListener<AcknowledgedResponse> listener =
    new ActionListener<AcknowledgedResponse>() {
        @Override
        public void onResponse(AcknowledgedResponse putMappingResponse) {
            
        }

        @Override
        public void onFailure(Exception e) {
            
        }
    };

Called when the execution is successfully completed.

Called when the whole PutMappingRequest fails.

Put Mapping Response

The returned PutMappingResponse allows to retrieve information about the executed operation as follows:

boolean acknowledged = putMappingResponse.isAcknowledged(); 

Indicates whether all of the nodes have acknowledged the request