Get Component Templates APIedit

The Get Component Templates API allows to retrieve information about one or more component templates.

Get Component Templates Requestedit

A GetComponentTemplatesRequest specifies one component template name to retrieve. To return all component templates omit the name altogether.

GetComponentTemplatesRequest request = new GetComponentTemplatesRequest("ct1"); 

A single component template name


Timeout to connect to the master node as a TimeValue

Timeout to connect to the master node as a String

Synchronous executionedit

When executing a GetComponentTemplatesRequest in the following manner, the client waits for the GetComponentTemplatesResponse to be returned before continuing with code execution:

GetComponentTemplatesResponse getTemplatesResponse = client.cluster().getComponentTemplate(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 executionedit

Executing a GetComponentTemplatesRequest 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-component-templates method:

client.cluster().getComponentTemplateAsync(request, RequestOptions.DEFAULT, listener); 

The GetComponentTemplatesRequest 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 get-component-templates looks like:

ActionListener<GetComponentTemplatesResponse> listener =
    new ActionListener<GetComponentTemplatesResponse>() {
        public void onResponse(GetComponentTemplatesResponse response) {

        public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole GetComponentTemplatesRequest fails.

Get Component Templates Responseedit

The returned GetComponentTemplatesResponse consists a map of component template names and their corresponding definition.

Map<String, ComponentTemplate> templates = getTemplatesResponse.getComponentTemplates(); 

A map of matching component template names and the corresponding definitions