WARNING: Version 5.4 of the Elastic Stack has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Flush Jobs
editFlush Jobs
editThe flush job API forces any buffered data to be processed by the job.
Request
editPOST _xpack/ml/anomaly_detectors/<job_id>/_flush
Description
editThe flush job API is only applicable when sending data for analysis using the post data API. Depending on the content of the buffer, then it might additionally calculate new results.
Both flush and close operations are similar, however the flush is more efficient if you are expecting to send more data for analysis. When flushing, the job remains open and is available to continue analyzing data. A close operation additionally prunes and persists the model state to disk and the job must be opened again before analyzing further data.
Path Parameters
edit-
job_id(required) - (string) Identifier for the job
Query Parameters
edit-
advance_time -
(string) Specifies that no data prior to the date
advance_timeis expected. -
end -
(string) When used in conjunction with
calc_interim, specifies the range of buckets on which to calculate interim results. -
calc_interim - (boolean) If true, calculates the interim results for the most recent bucket or all buckets within the latency period.
-
start -
(string) When used in conjunction with
calc_interim, specifies the range of buckets on which to calculate interim results.
Authorization
editYou must have manage_ml, or manage cluster privileges to use this API.
For more information, see Cluster Privileges.
Examples
editThe following example flushes the farequote job:
POST _xpack/ml/anomaly_detectors/farequote/_flush
{
"calc_interim": true
}
When the operation succeeds, you receive the following results:
{
"flushed": true
}