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
editWhen executing a GetIndexTemplatesRequest
in the following manner, the client waits
for the GetIndexTemplatesResponse
to be returned before continuing with code execution:
GetIndexTemplatesResponse getTemplatesResponse = client.indices().getIndexTemplate(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 GetIndexTemplatesRequest
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 get-templates 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 get-templates
looks like:
Get Templates Response
editThe returned GetIndexTemplatesResponse
consists a list of matching index templates.