New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Validate Query API Get Index API »
Elastic Docs ›Java REST Client [6.4] ›Java High Level REST Client ›Indices APIs

Get Templates API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get Templates API

edit

The Get Templates API allows to retrieve a list of index templates by name.

Get Index Templates Request

edit

A GetIndexTemplatesRequest specifies one or several names of the index templates to get.

GetIndexTemplatesRequest request = new GetIndexTemplatesRequest("my-template"); 
request.names("template-1", "template-2"); 
request.names("my-*");

A single index template name

Multiple index template names

An index template name using wildcard

 
request.masterNodeTimeout(TimeValue.timeValueMinutes(1)); 
request.masterNodeTimeout("1m");

Timeout to connect to the master node as a TimeValue

Timeout to connect to the master node as a String

Synchronous Execution

edit
GetIndexTemplatesResponse getTemplatesResponse = client.indices().getTemplate(request, RequestOptions.DEFAULT);

Asynchronous Execution

edit

The asynchronous execution of a get index templates request requires a GetTemplatesRequest instance and an ActionListener instance to be passed to the asynchronous method:

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

The GetTemplatesRequest 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.

A typical listener for GetTemplatesResponse looks like:

ActionListener<GetIndexTemplatesResponse> listener =
    new ActionListener<GetIndexTemplatesResponse>() {
        @Override
        public void onResponse(GetIndexTemplatesResponse response) {
            
        }

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

Called when the execution is successfully completed. The response is provided as an argument

Called in case of failure. The raised exception is provided as an argument

Get Templates Response

edit

The returned GetTemplatesResponse consists a list of matching index templates.

List<IndexTemplateMetaData> templates = getTemplatesResponse.getIndexTemplates();

A list of matching index templates
« Validate Query API Get Index API »