Delete Calendar Event API

Removes a scheduled event from an existing machine learning calendar. The API accepts a DeleteCalendarEventRequest and responds with a AcknowledgedResponse object.

Delete Calendar Event Request

A DeleteCalendarEventRequest is constructed referencing a non-null calendar ID, and eventId which to remove from the calendar

DeleteCalendarEventRequest request = new DeleteCalendarEventRequest("holidays", 
    "EventId"); 

The ID of the calendar from which to remove the jobs

The eventId to remove from the calendar

Delete Calendar Event Response

The returned AcknowledgedResponse acknowledges the success of the request:

boolean acknowledged = response.isAcknowledged(); 

Acknowledgement of the request and its success

Synchronous Execution

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

AcknowledgedResponse response = client.machineLearning().deleteCalendarEvent(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

Executing a DeleteCalendarEventRequest 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 delete-calendar-event method:

client.machineLearning().deleteCalendarEventAsync(request, RequestOptions.DEFAULT, listener); 

The DeleteCalendarEventRequest 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 delete-calendar-event looks like:

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

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

Called when the execution is successfully completed.

Called when the whole DeleteCalendarEventRequest fails.