Start data frame analytics jobs APIedit

This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Starts an existing data frame analytics job. It accepts a StartDataFrameAnalyticsRequest object and responds with a AcknowledgedResponse object.

Start data frame analytics job requestedit

A StartDataFrameAnalyticsRequest object requires a data frame analytics job ID.

StartDataFrameAnalyticsRequest request = new StartDataFrameAnalyticsRequest("my-analytics-config"); 

Constructing a new start request referencing an existing data frame analytics job

Synchronous executionedit

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

StartDataFrameAnalyticsResponse response = client.machineLearning().startDataFrameAnalytics(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 executionedit

Executing a StartDataFrameAnalyticsRequest 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-data-frame-analytics method:

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

The StartDataFrameAnalyticsRequest 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. Failure scenarios and expected exceptions are the same as in the synchronous execution case.

A typical listener for start-data-frame-analytics looks like:

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

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

Called when the execution is successfully completed.

Called when the whole StartDataFrameAnalyticsRequest fails.

Start data frame analytics job responseedit

The returned AcknowledgedResponse object acknowledges the data frame analytics job has started.

boolean acknowledged = response.isAcknowledged();
String node = response.getNode(); 

getNode() returns the node that the job was assigned to. If the job is allowed to open lazily and has not yet been assigned to a node then an empty string is returned. If getNode() returns null then the server is an old version that does not return node information.