IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Get Templates API
editGet Templates API
editThe Get Templates API allows to retrieve a list of index templates by name.
Get Index Templates Request
editA GetIndexTemplatesRequest
specifies one or several names of the index templates to get.
Synchronous Execution
editGetIndexTemplatesResponse getTemplatesResponse = client.indices().getTemplate(request, RequestOptions.DEFAULT);
Asynchronous Execution
editThe asynchronous execution of a get index templates request requires a GetTemplatesRequest
instance and an ActionListener
instance to be passed to the asynchronous
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.
A typical listener for GetTemplatesResponse
looks like:
Get Templates Response
editThe returned GetTemplatesResponse
consists a list of matching index templates.