Post Calendar Event API

Adds new ScheduledEvents to an existing machine learning calendar.

The API accepts a PostCalendarEventRequest and responds with a PostCalendarEventResponse object.

Post Calendar Event Request

A PostCalendarEventRequest is constructed with a calendar ID object and a non-empty list of scheduled events.

PostCalendarEventRequest request = new PostCalendarEventRequest("holidays", 
    events); 

Non-null existing calendar ID

Non-null, non-empty collection of ScheduledEvent objects

Post Calendar Event Response

The returned PostCalendarEventResponse contains the added ScheduledEvent objects:

List<ScheduledEvent> scheduledEvents = response.getScheduledEvents(); 

The ScheduledEvent objects that were added to the calendar

Synchronous Execution

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

PostCalendarEventResponse response = client.machineLearning().postCalendarEvent(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 PostCalendarEventRequest 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 post-calendar-event method:

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

The PostCalendarEventRequest 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 post-calendar-event looks like:

ActionListener<PostCalendarEventResponse> listener =
    new ActionListener<PostCalendarEventResponse>() {
        @Override
        public void onResponse(PostCalendarEventResponse postCalendarsResponse) {
            
        }

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

Called when the execution is successfully completed.

Called when the whole PostCalendarEventRequest fails.