- Java REST Client (deprecated): other versions:
- Overview
- Java Low Level REST Client
- Java High Level REST Client
- Getting started
- Document APIs
- Search APIs
- Miscellaneous APIs
- Indices APIs
- Analyze API
- Create Index API
- Delete Index API
- Indices Exists API
- Open Index API
- Close Index API
- Shrink Index API
- Split Index API
- Refresh API
- Flush API
- Flush Synced API
- Clear Cache API
- Force Merge API
- Rollover Index API
- Put Mapping API
- Get Mappings API
- Get Field Mappings API
- Index Aliases API
- Exists Alias API
- Get Alias API
- Update Indices Settings API
- Get Settings API
- Put Template API
- Validate Query API
- Get Templates API
- Get Index API
- Cluster APIs
- Ingest APIs
- Snapshot APIs
- Tasks APIs
- Script APIs
- Licensing APIs
- Machine Learning APIs
- Put Job API
- Get Job API
- Delete Job API
- Open Job API
- Close Job API
- Update Job API
- Flush Job API
- Put Datafeed API
- Get Datafeed API
- Delete Datafeed API
- Preview Datafeed API
- Start Datafeed API
- Stop Datafeed API
- Get Datafeed Stats API
- Get Job Stats API
- Forecast Job API
- Delete Forecast API
- Get Buckets API
- Get Overall Buckets API
- Get Records API
- Post Data API
- Get Influencers API
- Get Categories API
- Get Calendars API
- Put Calendar API
- Delete Calendar API
- Migration APIs
- Rollup APIs
- Security APIs
- Watcher APIs
- Graph APIs
- Using Java Builders
- Migration Guide
- License
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);
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.
A typical listener for post-data
looks like:
Post Data Response
editA PostDataResponse
contains current data processing statistics.
On this page