4
4
:response: PutDatafeedResponse
5
5
--
6
6
[id="{upid} -{api} "]
7
- === Put Datafeed API
7
+ === Put datafeed API
8
8
9
- The Put Datafeed API can be used to create a new {ml} datafeed
10
- in the cluster. The API accepts a +{request}+ object
9
+ Creates a new {ml} datafeed in the cluster. The API accepts a +{request}+ object
11
10
as a request and returns a +{response}+ .
12
11
13
12
[id="{upid}-{api}-request"]
14
- ==== Put Datafeed Request
13
+ ==== Put datafeed request
15
14
16
15
A +{request}+ requires the following argument:
17
16
18
17
["source","java",subs="attributes,callouts,macros"]
19
18
--------------------------------------------------
20
19
include-tagged::{doc-tests-file}[{api}-request]
21
20
--------------------------------------------------
22
- <1> The configuration of the {ml} datafeed to create
21
+ <1> The configuration of the {ml} datafeed to create.
23
22
24
23
[id="{upid}-{api}-config"]
25
- ==== Datafeed Configuration
24
+ ==== Datafeed configuration
26
25
27
26
The `DatafeedConfig` object contains all the details about the {ml} datafeed
28
27
configuration.
@@ -33,10 +32,10 @@ A `DatafeedConfig` requires the following arguments:
33
32
--------------------------------------------------
34
33
include-tagged::{doc-tests-file}[{api}-config]
35
34
--------------------------------------------------
36
- <1> The datafeed ID and the job ID
37
- <2> The indices that contain the data to retrieve and feed into the job
35
+ <1> The datafeed ID and the {anomaly- job} ID.
36
+ <2> The indices that contain the data to retrieve and feed into the {anomaly- job}.
38
37
39
- ==== Optional Arguments
38
+ ==== Optional arguments
40
39
The following arguments are optional:
41
40
42
41
["source","java",subs="attributes,callouts,macros"]
@@ -49,7 +48,8 @@ include-tagged::{doc-tests-file}[{api}-config-set-chunking-config]
49
48
--------------------------------------------------
50
49
include-tagged::{doc-tests-file}[{api}-config-set-frequency]
51
50
--------------------------------------------------
52
- <1> The interval at which scheduled queries are made while the datafeed runs in real time.
51
+ <1> The interval at which scheduled queries are made while the datafeed runs in
52
+ real time.
53
53
54
54
["source","java",subs="attributes,callouts,macros"]
55
55
--------------------------------------------------
@@ -72,8 +72,9 @@ The window must be larger than the Job's bucket size, but smaller than 24 hours,
72
72
and span less than 10,000 buckets.
73
73
Defaults to `null`, which causes an appropriate window span to be calculated when
74
74
the datafeed runs.
75
- The default `check_window` span calculation is the max between `2h` or `8 * bucket_span`.
76
- To explicitly disable, pass `DelayedDataCheckConfig.disabledDelayedDataCheckConfig()`.
75
+ The default `check_window` span calculation is the max between `2h` or
76
+ `8 * bucket_span`. To explicitly disable, pass
77
+ `DelayedDataCheckConfig.disabledDelayedDataCheckConfig()`.
77
78
78
79
["source","java",subs="attributes,callouts,macros"]
79
80
--------------------------------------------------
@@ -101,4 +102,4 @@ default values:
101
102
--------------------------------------------------
102
103
include-tagged::{doc-tests-file}[{api}-response]
103
104
--------------------------------------------------
104
- <1> The created datafeed
105
+ <1> The created datafeed.
0 commit comments