"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "docs/reference/ml/apis/close-job.asciidoc" between
elasticsearch-6.8.2-src.tar.gz and elasticsearch-6.8.3-src.tar.gz

About: elasticsearch is a Distributed, RESTful, Search Engine built on top of Apache Lucene. Source package (GitHub).

close-job.asciidoc  (elasticsearch-6.8.2-src):close-job.asciidoc  (elasticsearch-6.8.3-src)
skipping to change at line 15 skipping to change at line 15
++++ ++++
<titleabbrev>Close jobs</titleabbrev> <titleabbrev>Close jobs</titleabbrev>
++++ ++++
Closes one or more jobs. Closes one or more jobs.
A job can be opened and closed multiple times throughout its lifecycle. A job can be opened and closed multiple times throughout its lifecycle.
A closed job cannot receive data or perform analysis A closed job cannot receive data or perform analysis
operations, but you can still explore and navigate results. operations, but you can still explore and navigate results.
==== Request [[ml-close-job-request]]
==== {api-request-title}
`POST _xpack/ml/anomaly_detectors/<job_id>/_close` + `POST _xpack/ml/anomaly_detectors/<job_id>/_close` +
`POST _xpack/ml/anomaly_detectors/<job_id>,<job_id>/_close` + `POST _xpack/ml/anomaly_detectors/<job_id>,<job_id>/_close` +
`POST _xpack/ml/anomaly_detectors/_all/_close` + `POST _xpack/ml/anomaly_detectors/_all/_close` +
==== Description [[ml-close-job-prereqs]]
==== {api-prereq-title}
You must have `manage_ml`, or `manage` cluster privileges to use this API.
For more information, see {xpack-ref}/security-privileges.html[Security Privileg
es].
[[ml-close-job-desc]]
==== {api-description-title}
You can close multiple jobs in a single API request by using a group name, a You can close multiple jobs in a single API request by using a group name, a
comma-separated list of jobs, or a wildcard expression. You can close all jobs comma-separated list of jobs, or a wildcard expression. You can close all jobs
by using `_all` or by specifying `*` as the `<job_id>`. by using `_all` or by specifying `*` as the `<job_id>`.
When you close a job, it runs housekeeping tasks such as pruning the model histo ry, When you close a job, it runs housekeeping tasks such as pruning the model histo ry,
flushing buffers, calculating final results and persisting the model snapshots. flushing buffers, calculating final results and persisting the model snapshots.
Depending upon the size of the job, it could take several minutes to close and Depending upon the size of the job, it could take several minutes to close and
the equivalent time to re-open. the equivalent time to re-open.
skipping to change at line 48 skipping to change at line 56
When a {dfeed} that has a specified end date stops, it automatically closes When a {dfeed} that has a specified end date stops, it automatically closes
the job. the job.
NOTE: If you use the `force` query parameter, the request returns without perfor ming NOTE: If you use the `force` query parameter, the request returns without perfor ming
the associated actions such as flushing buffers and persisting the model snapsho ts. the associated actions such as flushing buffers and persisting the model snapsho ts.
Therefore, do not use this parameter if you want the job to be in a consistent s tate Therefore, do not use this parameter if you want the job to be in a consistent s tate
after the close job API returns. The `force` query parameter should only be use d in after the close job API returns. The `force` query parameter should only be use d in
situations where the job has already failed, or where you are not interested in situations where the job has already failed, or where you are not interested in
results the job might have recently produced or might produce in the future. results the job might have recently produced or might produce in the future.
==== Path Parameters [[ml-close-job-path-parms]]
==== {api-path-parms-title}
`job_id`:: `job_id`::
(string) Identifier for the job. It can be a job identifier, a group name, or (string) Identifier for the job. It can be a job identifier, a group name, or
a wildcard expression. a wildcard expression.
==== Query Parameters [[ml-close-job-query-parms]]
==== {api-query-parms-title}
`allow_no_jobs`::
(Optional, boolean) Specifies what to do when the request:
+
--
* Contains wildcard expressions and there are no jobs that match.
* Contains the `_all` string or no identifiers and there are no matches.
* Contains wildcard expressions and there are only partial matches.
The default value is `true`, which returns an empty `jobs` array
when there are no matches and the subset of results when there are partial
matches. If this parameter is `false`, the request returns a `404` status code
when there are no matches or only partial matches.
--
`force`:: `force`::
(boolean) Use to close a failed job, or to forcefully close a job which has no t (boolean) Use to close a failed job, or to forcefully close a job which has no t
responded to its initial close request. responded to its initial close request.
`timeout`:: `timeout`::
(time units) Controls the time to wait until a job has closed. (time units) Controls the time to wait until a job has closed.
The default value is 30 minutes. The default value is 30 minutes.
==== Authorization [[ml-close-job-response-codes]]
==== {api-response-codes-title}
You must have `manage_ml`, or `manage` cluster privileges to use this API. `404` (Missing resources)::
For more information, see {xpack-ref}/security-privileges.html[Security Privileg If `allow_no_jobs` is `false`, this code indicates that there are no
es]. resources that match the request or only partial matches for the request.
==== Examples [[ml-close-job-example]]
==== {api-examples-title}
The following example closes the `total-requests` job: The following example closes the `total-requests` job:
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
POST _xpack/ml/anomaly_detectors/total-requests/_close POST _xpack/ml/anomaly_detectors/total-requests/_close
-------------------------------------------------- --------------------------------------------------
// CONSOLE // CONSOLE
// TEST[skip:setup:server_metrics_openjob] // TEST[skip:setup:server_metrics_openjob]
 End of changes. 7 change blocks. 
9 lines changed or deleted 36 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)