Put Calendar API

edit

Creates a new machine learning calendar. The API accepts a PutCalendarRequest and responds with a PutCalendarResponse object.

Put Calendar Request

edit

A PutCalendarRequest is constructed with a Calendar object

Calendar calendar = new Calendar("public_holidays", Collections.singletonList("job_1"), "A calendar for public holidays");
PutCalendarRequest request = new PutCalendarRequest(calendar); 

Create a request with the given Calendar

Put Calendar Response

edit

The returned PutCalendarResponse contains the created Calendar:

Calendar newCalendar = response.getCalendar(); 

The created Calendar

Synchronous Execution

edit

When 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

edit

Executing 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:

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

The PutCalendarRequest 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.

A typical listener for put-calendar looks like:

ActionListener<PutCalendarResponse> listener = new ActionListener<PutCalendarResponse>() {
    @Override
    public void onResponse(PutCalendarResponse response) {
        
    }

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

Called when the execution is successfully completed.

Called when the whole PutCalendarRequest fails.