Post Data API

The Post Data API provides the ability to post data to an open machine learning job in the cluster. It accepts a PostDataRequest object and responds with a PostDataResponse object.

Post Data Request

A PostDataRequest object gets created with an existing non-null jobId and the XContentType being sent. Individual docs can be added incrementally via the PostDataRequest.JsonBuilder#addDoc method. These are then serialized and sent in bulk when passed to the PostDataRequest.

Alternatively, the serialized bulk content can be set manually, along with its XContentType through one of the other PostDataRequest constructors.

Only XContentType.JSON and XContentType.SMILE are supported.

PostDataRequest.JsonBuilder jsonBuilder = new PostDataRequest.JsonBuilder(); 
Map<String, Object> mapData = new HashMap<>();
mapData.put("total", 109);
jsonBuilder.addDoc(mapData); 
jsonBuilder.addDoc("{\"total\":1000}"); 
PostDataRequest postDataRequest = new PostDataRequest("test-post-data", jsonBuilder); 

Create a new PostDataRequest.JsonBuilder object for incrementally adding documents

Add a new document as a Map<String, Object> object

Add a new document as a serialized JSON formatted String.

Constructing a new request referencing an opened jobId, and a JsonBuilder

Optional Arguments

The following arguments are optional.

postDataRequest.setResetStart("2018-08-31T16:35:07+00:00"); 
postDataRequest.setResetEnd("2018-08-31T16:35:17+00:00"); 

Set the start of the bucket resetting time

Set the end of the bucket resetting time

Synchronous Execution

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

PostDataResponse postDataResponse = client.machineLearning().postData(postDataRequest, 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

Executing a PostDataRequest 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 post-data method:

client.machineLearning().postDataAsync(postDataRequest, RequestOptions.DEFAULT, listener); 

The PostDataRequest 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 post-data looks like:

ActionListener<PostDataResponse> listener = new ActionListener<PostDataResponse>() {
    @Override
    public void onResponse(PostDataResponse postDataResponse) {
        
    }

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

Called when the execution is successfully completed.

Called when the whole PostDataRequest fails.

Post Data Response

A PostDataResponse contains current data processing statistics.

DataCounts dataCounts = postDataResponse.getDataCounts(); 

getDataCounts() a DataCounts object containing the current data processing counts.