NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.
Post Data API
editPost Data API
editThe 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
editA 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);
Optional Arguments
editThe following arguments are optional.
Synchronous Execution
editWhen 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
editExecuting 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:
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:
Post Data Response
editA PostDataResponse contains current data processing statistics.