|
@@ -4,14 +4,13 @@
|
|
|
:response: PutDatafeedResponse
|
|
|
--
|
|
|
[id="{upid}-{api}"]
|
|
|
-=== Put Datafeed API
|
|
|
+=== Put datafeed API
|
|
|
|
|
|
-The Put Datafeed API can be used to create a new {ml} datafeed
|
|
|
-in the cluster. The API accepts a +{request}+ object
|
|
|
+Creates a new {ml} datafeed in the cluster. The API accepts a +{request}+ object
|
|
|
as a request and returns a +{response}+.
|
|
|
|
|
|
[id="{upid}-{api}-request"]
|
|
|
-==== Put Datafeed Request
|
|
|
+==== Put datafeed request
|
|
|
|
|
|
A +{request}+ requires the following argument:
|
|
|
|
|
@@ -19,10 +18,10 @@ A +{request}+ requires the following argument:
|
|
|
--------------------------------------------------
|
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
|
--------------------------------------------------
|
|
|
-<1> The configuration of the {ml} datafeed to create
|
|
|
+<1> The configuration of the {ml} datafeed to create.
|
|
|
|
|
|
[id="{upid}-{api}-config"]
|
|
|
-==== Datafeed Configuration
|
|
|
+==== Datafeed configuration
|
|
|
|
|
|
The `DatafeedConfig` object contains all the details about the {ml} datafeed
|
|
|
configuration.
|
|
@@ -33,10 +32,10 @@ A `DatafeedConfig` requires the following arguments:
|
|
|
--------------------------------------------------
|
|
|
include-tagged::{doc-tests-file}[{api}-config]
|
|
|
--------------------------------------------------
|
|
|
-<1> The datafeed ID and the job ID
|
|
|
-<2> The indices that contain the data to retrieve and feed into the job
|
|
|
+<1> The datafeed ID and the {anomaly-job} ID.
|
|
|
+<2> The indices that contain the data to retrieve and feed into the {anomaly-job}.
|
|
|
|
|
|
-==== Optional Arguments
|
|
|
+==== Optional arguments
|
|
|
The following arguments are optional:
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
@@ -49,7 +48,8 @@ include-tagged::{doc-tests-file}[{api}-config-set-chunking-config]
|
|
|
--------------------------------------------------
|
|
|
include-tagged::{doc-tests-file}[{api}-config-set-frequency]
|
|
|
--------------------------------------------------
|
|
|
-<1> The interval at which scheduled queries are made while the datafeed runs in real time.
|
|
|
+<1> The interval at which scheduled queries are made while the datafeed runs in
|
|
|
+real time.
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
--------------------------------------------------
|
|
@@ -72,8 +72,9 @@ The window must be larger than the Job's bucket size, but smaller than 24 hours,
|
|
|
and span less than 10,000 buckets.
|
|
|
Defaults to `null`, which causes an appropriate window span to be calculated when
|
|
|
the datafeed runs.
|
|
|
-The default `check_window` span calculation is the max between `2h` or `8 * bucket_span`.
|
|
|
-To explicitly disable, pass `DelayedDataCheckConfig.disabledDelayedDataCheckConfig()`.
|
|
|
+The default `check_window` span calculation is the max between `2h` or
|
|
|
+`8 * bucket_span`. To explicitly disable, pass
|
|
|
+`DelayedDataCheckConfig.disabledDelayedDataCheckConfig()`.
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
--------------------------------------------------
|
|
@@ -101,4 +102,4 @@ default values:
|
|
|
--------------------------------------------------
|
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
|
--------------------------------------------------
|
|
|
-<1> The created datafeed
|
|
|
+<1> The created datafeed.
|