OpenSearch/docs/en/rest-api/ml/flush-job.asciidoc

//lcawley: Verified example output 2017-04-11
[[ml-flush-job]]
==== Flush Jobs

The flush job API forces any buffered data to be processed by the job.

===== Request

`POST _xpack/ml/anomaly_detectors/<job_id>/_flush`

===== Description

The flush job API is only applicable when sending data for analysis using the <<ml-post-data,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.

You must have `manage_ml`, or `manage` cluster privileges to use this API.
For more information, see <<privileges-list-cluster>>.

===== Path Parameters

`job_id` (required)::
(string)    Identifier for the job

===== Query Parameters

`advance_time`::
  (string) Specifies that no data prior to the date `advance_time` is 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.

////
===== Responses
200
(EmptyResponse) The cluster has been successfully deleted
404
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: clusters.cluster_not_found)
412
(BasicFailedReply) The Elasticsearch cluster has not been shutdown yet (code: clusters.cluster_plan_state_error)
////
===== Examples

The following example flushes the `farequote` job:

[source,js]
--------------------------------------------------
POST _xpack/ml/anomaly_detectors/farequote/_flush
{
  "calc_interim": true
}
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]

When the operation succeeds, you receive the following results:
[source,js]
----
{
  "flushed": true
}
----