NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

« Put Stored Script API Licensing APIs »

› › ›

Delete Stored Script API

edit

Delete Stored Script API

edit

Delete Stored Script Request

edit

A DeleteStoredScriptRequest requires an id:

DeleteStoredScriptRequest deleteRequest = new DeleteStoredScriptRequest("calculate-score");

The id of the script

Optional arguments

edit

The following arguments can optionally be provided:

deleteRequest.timeout(TimeValue.timeValueSeconds(60)); 
deleteRequest.timeout("60s");

	Timeout to wait for the all the nodes to acknowledge the stored script is deleted as a `TimeValue`
	Timeout to wait for the all the nodes to acknowledge the stored script is deleted as a `String`

deleteRequest.masterNodeTimeout(TimeValue.timeValueSeconds(50)); 
deleteRequest.masterNodeTimeout("50s");

	Timeout to connect to the master node as a `TimeValue`
	Timeout to connect to the master node as a `String`

Synchronous Execution

edit

AcknowledgedResponse deleteResponse = client.deleteScript(deleteRequest, RequestOptions.DEFAULT);

Asynchronous Execution

edit

The asynchronous execution of a delete stored script request requires both the DeleteStoredScriptRequest instance and an ActionListener instance to be passed to the asynchronous method:

client.deleteScriptAsync(deleteRequest, RequestOptions.DEFAULT, listener);

The DeleteStoredScriptRequest to execute and the ActionListener to use when the execution completes

Action Listener

edit

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 DeleteStoredScriptResponse looks like:

ActionListener<AcknowledgedResponse> listener =
    new ActionListener<AcknowledgedResponse>() {
        @Override
        public void onResponse(AcknowledgedResponse 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

Delete Stored Script Response

edit

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

boolean acknowledged = deleteResponse.isAcknowledged();

Indicates whether all of the nodes have acknowledged the request

« Put Stored Script API Licensing APIs »