- Java REST Client (deprecated): other versions:
- Overview
- Java Low Level REST Client
- Java High Level REST Client
- Getting started
- Document APIs
- Search APIs
- Miscellaneous APIs
- Indices APIs
- Analyze API
- Create Index API
- Delete Index API
- Indices Exists API
- Open Index API
- Close Index API
- Shrink Index API
- Split Index API
- Refresh API
- Flush API
- Flush Synced API
- Clear Cache API
- Force Merge API
- Rollover Index API
- Put Mapping API
- Get Mappings API
- Get Field Mappings API
- Index Aliases API
- Exists Alias API
- Get Alias API
- Update Indices Settings API
- Get Settings API
- Put Template API
- Validate Query API
- Get Templates API
- Get Index API
- Cluster APIs
- Ingest APIs
- Snapshot APIs
- Tasks APIs
- Script APIs
- Licensing APIs
- Machine Learning APIs
- Put Job API
- Get Job API
- Delete Job API
- Open Job API
- Close Job API
- Update Job API
- Flush Job API
- Put Datafeed API
- Get Datafeed API
- Delete Datafeed API
- Preview Datafeed API
- Start Datafeed API
- Stop Datafeed API
- Get Datafeed Stats API
- Get Job Stats API
- Forecast Job API
- Delete Forecast API
- Get Buckets API
- Get Overall Buckets API
- Get Records API
- Post Data API
- Get Influencers API
- Get Categories API
- Get Calendars API
- Put Calendar API
- Delete Calendar API
- Migration APIs
- Rollup APIs
- Security APIs
- Watcher APIs
- Graph APIs
- Using Java Builders
- Migration Guide
- License
Put Calendar API
editPut Calendar API
editCreates a new machine learning calendar.
The API accepts a PutCalendarRequest
and responds
with a PutCalendarResponse
object.
Put Calendar Request
editA PutCalendarRequest
is constructed with a Calendar object
Put Calendar Response
editThe returned PutCalendarResponse
contains the created Calendar:
Synchronous Execution
editWhen executing a PutCalendarRequest
in the following manner, the client waits
for the PutCalendarResponse
to be returned before continuing with code execution:
PutCalendarResponse response = client.machineLearning().putCalendar(request, RequestOptions.DEFAULT);
Asynchronous Execution
editExecuting a PutCalendarRequest
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 put-calendar 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 put-calendar
looks like: