Delete Calendar Job API

Removes machine learning jobs from an existing machine learning calendar. The API accepts a DeleteCalendarJobRequest and responds with a PutCalendarResponse object.

Delete Calendar Job Request

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

DeleteCalendarJobRequest request = new DeleteCalendarJobRequest("holidays", 
    "job_1", "job_group_1"); 

The ID of the calendar from which to remove the jobs

The JobIds to remove from the calendar

Delete Calendar Job Response

The returned PutCalendarResponse contains the updated Calendar:

Calendar updatedCalendar = response.getCalendar(); 

The updated Calendar with the jobs removed

Synchronous Execution

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

PutCalendarResponse response = client.machineLearning().deleteCalendarJob(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 DeleteCalendarJobRequest 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-job method:

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

The DeleteCalendarJobRequest 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-job looks like:

ActionListener<PutCalendarResponse> listener =
    new ActionListener<PutCalendarResponse>() {
        @Override
        public void onResponse(PutCalendarResponse deleteCalendarsResponse) {
            
        }

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

Called when the execution is successfully completed.

Called when the whole DeleteCalendarJobRequest fails.