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);
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
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. Failure scenarios and expected exceptions are the same as in the
synchronous execution case.
A typical listener for get-calendars
looks like:
Get calendars response
editThe returned GetCalendarsResponse
contains the requested calendars: