60 lines
2.0 KiB
Plaintext
60 lines
2.0 KiB
Plaintext
--
|
|
:api: update-datafeed
|
|
:request: UpdateDatafeedRequest
|
|
:response: PutDatafeedResponse
|
|
--
|
|
[role="xpack"]
|
|
[id="{upid}-{api}"]
|
|
=== Update datafeed API
|
|
|
|
Updates a {ml} datafeed in the cluster. The API accepts a +{request}+ object
|
|
as a request and returns a +{response}+.
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Update datafeed request
|
|
|
|
A +{request}+ requires the following argument:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
<1> The updated configuration of the {ml} datafeed
|
|
|
|
[id="{upid}-{api}-config"]
|
|
==== Updated datafeed arguments
|
|
|
|
A `DatafeedUpdate` requires an existing non-null `datafeedId` and
|
|
allows updating various settings.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-config]
|
|
--------------------------------------------------
|
|
<1> Mandatory, non-null `datafeedId` referencing an existing {ml} datafeed.
|
|
<2> Optional, set the datafeed aggregations for data gathering.
|
|
<3> Optional, the indices that contain the data to retrieve and feed into the
|
|
{anomaly-job}.
|
|
<4> Optional, specifies how data searches are split into time chunks.
|
|
<5> Optional, the interval at which scheduled queries are made while the
|
|
datafeed runs in real time.
|
|
<6> Optional, a query to filter the search results by. Defaults to the
|
|
`match_all` query.
|
|
<7> Optional, the time interval behind real time that data is queried.
|
|
<8> Optional, allows the use of script fields.
|
|
<9> Optional, the `size` parameter used in the searches.
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Response
|
|
|
|
The returned +{response}+ returns the full representation of
|
|
the updated {ml} datafeed if it has been successfully updated.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|
|
<1> The updated datafeed.
|