Get Calendar Events API

Retrieves a calendars events. It accepts a GetCalendarEventsRequest and responds with a GetCalendarEventsResponse object.

Get Calendars Request

A GetCalendarEventsRequest requires a non-null calendar ID. Using the literal _all returns the events for all calendars.

GetCalendarEventsRequest request = new GetCalendarEventsRequest("holidays"); 

Constructing a new request for the specified calendarId

Optional Arguments

The following arguments are optional:

request.setPageParams(new PageParams(10, 20)); 

The page parameters from and size. from specifies the number of events to skip. size specifies the maximum number of events to get. Defaults to 0 and 100 respectively.

request.setStart("2018-08-01T00:00:00Z"); 

Specifies to get events with timestamps after this time.

request.setEnd("2018-08-02T00:00:00Z"); 

Specifies to get events with timestamps earlier than this time.

request.setJobId("job_1"); 

Get events for the job. When this option is used calendar_id must be _all

Synchronous Execution

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

GetCalendarEventsResponse response = client.machineLearning().getCalendarEvents(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 GetCalendarEventsRequest 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 get-calendar-events method:

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

The GetCalendarEventsRequest 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 get-calendar-events looks like:

ActionListener<GetCalendarEventsResponse> listener =
    new ActionListener<GetCalendarEventsResponse>() {
        @Override
        public void onResponse(GetCalendarEventsResponse getCalendarsResponse) {
            
        }

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

Called when the execution is successfully completed.

Called when the whole GetCalendarEventsRequest fails.

Get calendars Response

The returned GetCalendarEventsResponse contains the requested events:

long count = response.count(); 
List<ScheduledEvent> scheduledEvents = response.events(); 

The count of events that were matched

The events retrieved