Get Calendars API

Retrieves one or more calendar objects. It accepts a GetCalendarsRequest and responds with a GetCalendarsResponse object.

Get Calendars Request

By default a GetCalendarsRequest with no calendar Id set will return all calendars. Using the literal _all also returns all calendars.

GetCalendarsRequest request = new GetCalendarsRequest(); 

Constructing a new request for all calendars

Optional Arguments

The following arguments are optional:

request.setCalendarId("holidays"); 

Construct a request for the single calendar holidays

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

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

Synchronous Execution

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

GetCalendarsResponse response = client.machineLearning().getCalendars(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 GetCalendarsRequest 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-calendars method:

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

The GetCalendarsRequest 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-calendars looks like:

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

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

Called when the execution is successfully completed.

Called when the whole GetCalendarsRequest fails.

Get calendars Response

The returned GetCalendarsResponse contains the requested calendars:

long count = response.count(); 
List<Calendar> calendars = response.calendars(); 

The count of calendars that were matched

The calendars retrieved