IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Preview Datafeed API Stop Datafeed API »
Elastic Docs ›Java REST Client [6.5] ›Java High Level REST Client ›Machine Learning APIs

Start Datafeed API

edit

Start Datafeed API

edit

The Start Datafeed API provides the ability to start a machine learning datafeed in the cluster. It accepts a StartDatafeedRequest object and responds with a StartDatafeedResponse object.

Start Datafeed Request

edit

A StartDatafeedRequest object is created referencing a non-null datafeedId. All other fields are optional for the request.

StartDatafeedRequest request = new StartDatafeedRequest(datafeedId);

Constructing a new request referencing an existing datafeedId

Optional Arguments

edit

The following arguments are optional.

request.setEnd("2018-08-21T00:00:00Z"); 
request.setStart("2018-08-20T00:00:00Z"); 
request.setTimeout(TimeValue.timeValueMinutes(10));

Set when the datafeed should end, the value is exclusive. May be an epoch seconds, epoch millis or an ISO 8601 string. "now" is a special value that indicates the current time. If you do not specify an end time, the datafeed runs continuously.

Set when the datafeed should start, the value is inclusive. May be an epoch seconds, epoch millis or an ISO 8601 string. If you do not specify a start time and the datafeed is associated with a new job, the analysis starts from the earliest time for which data is available.

Set the timeout for the request

Synchronous Execution

edit

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

StartDatafeedResponse response = client.machineLearning().startDatafeed(request, RequestOptions.DEFAULT);

Asynchronous Execution

edit

Executing a StartDatafeedRequest 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 start-datafeed method:

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

The StartDatafeedRequest 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 start-datafeed looks like:

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

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

Called when the execution is successfully completed.

Called when the whole StartDatafeedRequest fails.
« Preview Datafeed API Stop Datafeed API »