Put Calendar Job API

Adds machine learning jobs to an existing machine learning calendar. The API accepts a PutCalendarJobRequest and responds with a PutCalendarResponse object.

Put Calendar Job Request

A PutCalendarJobRequest is constructed referencing a non-null calendar ID, and JobIDs to which to add to the calendar

PutCalendarJobRequest request = new PutCalendarJobRequest("holidays", 
    "job_2", "job_group_1"); 

The ID of the calendar to which to add the jobs

The JobIds to add to the calendar

Put Calendar Response

The returned PutCalendarResponse contains the updated Calendar:

Calendar updatedCalendar = response.getCalendar(); 

The updated Calendar

Synchronous Execution

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

PutCalendarResponse response = client.machineLearning().putCalendarJob(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 PutCalendarJobRequest 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-calendar-job method:

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

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

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

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

Called when the execution is successfully completed.

Called when the whole PutCalendarJobRequest fails.