WARNING: Deprecated in 7.15.0.
The Java REST Client is deprecated in favor of the Java API Client.
Starts a machine learning datafeed in the cluster. It accepts a
StartDatafeedRequest object and
responds with a
StartDatafeedRequest object is created referencing a non-null
All other fields are optional for the request.
The following arguments are optional.
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
When executing a
StartDatafeedRequest in the following manner, the client waits
StartDatafeedResponse to be returned before continuing with code execution:
StartDatafeedResponse response = client.machineLearning().startDatafeed(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
5xx error code, the high-level
client tries to parse the response body error details instead and then throws
ElasticsearchException and adds the original
ResponseException as a
suppressed exception to it.
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:
The asynchronous method does not block and returns immediately. Once it is
ActionListener is called back using the
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-datafeed looks like: