Put Template API
editPut Template API
editPut Index Template Request
editA PutIndexTemplateRequest
specifies the name
of a template and patterns
which controls whether the template should be applied to the new index.
Settings
editThe settings of the template will be applied to the new index whose name matches the template’s patterns.
Mappings
editThe mapping of the template will be applied to the new index whose name matches the template’s patterns.
request.mapping( "{\n" + " \"properties\": {\n" + " \"message\": {\n" + " \"type\": \"text\"\n" + " }\n" + " }\n" + "}", XContentType.JSON);
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> properties = new HashMap<>(); { Map<String, Object> message = new HashMap<>(); message.put("type", "text"); properties.put("message", message); } jsonMap.put("properties", properties); } request.mapping(jsonMap);
Aliases
editThe aliases of the template will define aliasing to the index whose name matches the
template’s patterns. A placeholder {index}
can be used in an alias of a template.
Order
editIn case multiple templates match an index, the orders of matching templates determine the sequence that settings, mappings, and alias of each matching template is applied. Templates with lower orders are applied first, and higher orders override them.
Version
editA template can optionally specify a version number which can be used to simplify template management by external systems.
Providing the whole source
editThe whole source including all of its sections (mappings, settings and aliases) can also be provided:
request.source("{\n" + " \"index_patterns\": [\n" + " \"log-*\",\n" + " \"pattern-1\"\n" + " ],\n" + " \"order\": 1,\n" + " \"settings\": {\n" + " \"number_of_shards\": 1\n" + " },\n" + " \"mappings\": {\n" + " \"properties\": {\n" + " \"message\": {\n" + " \"type\": \"text\"\n" + " }\n" + " }\n" + " },\n" + " \"aliases\": {\n" + " \"alias-1\": {},\n" + " \"{index}-alias\": {}\n" + " }\n" + "}", XContentType.JSON);
Optional arguments
editThe following arguments can optionally be provided:
Synchronous execution
editWhen executing a PutIndexTemplateRequest
in the following manner, the client waits
for the PutIndexTemplateResponse
to be returned before continuing with code execution:
AcknowledgedResponse putTemplateResponse = client.indices().putTemplate(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 PutIndexTemplateRequest
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-template 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-template
looks like:
Put Index Template Response
editThe returned PutIndexTemplateResponse
allows to retrieve information about the
executed operation as follows: