Optional argumentsedit

The following arguments can optionally be provided:

request.create(true);  

To force to only create a new template; do not overwrite the existing template

request.setMasterTimeout(TimeValue.timeValueMinutes(1)); 

Timeout to connect to the master node as a TimeValue

Synchronous executionedit

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

ActionListener<AcknowledgedResponse> listener =
    new ActionListener<AcknowledgedResponse>() {
        @Override
        public void onResponse(AcknowledgedResponse putComponentTemplateResponse) {
            
        }

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

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 PutComponentTemplateRequest 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-component-template method:

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

The PutComponentTemplateRequest 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 put-component-template looks like:

ActionListener<AcknowledgedResponse> listener =
    new ActionListener<AcknowledgedResponse>() {
        @Override
        public void onResponse(AcknowledgedResponse putComponentTemplateResponse) {
            
        }

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

Called when the execution is successfully completed.

Called when the whole PutComponentTemplateRequest fails.

Responseedit

The returned AcknowledgedResponse allows to retrieve information about the executed operation as follows:

boolean acknowledged = putComponentTemplateResponse.isAcknowledged(); 

Indicates whether all of the nodes have acknowledged the request