Get Calendars API
editGet Calendars API
editRetrieves one or more calendar objects.
It accepts a GetCalendarsRequest and responds
with a GetCalendarsResponse object.
Get Calendars Request
editBy default a GetCalendarsRequest with no calendar Id set will return all
calendars. Using the literal _all also returns all calendars.
Optional Arguments
editThe following arguments are optional:
Synchronous Execution
editWhen 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);
Asynchronous Execution
editExecuting 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:
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.
A typical listener for get-calendars looks like:
Get calendars Response
editThe returned GetCalendarsResponse contains the requested calendars: