mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-03-09 14:34:43 +00:00
f7ada9b29b
* ML: Adding missing datacheck to datafeedjob * Adding client side and docs * Making adjustments to validations * Making values default to on, having more sensible limits * Intermittent commit, still need to figure out interval * Adjusting delayed data check interval * updating docs * Making parameter Boolean, so it is nullable * bumping bwc to 7 before backport * changing to version current * moving delayed data check config its own object * Separation of duties for delayed data detection * fixing checkstyles * fixing checkstyles * Adjusting default behavior so that null windows are allowed * Mentioning the default value * Fixing comments, syncing up validations
104 lines
3.9 KiB
Plaintext
104 lines
3.9 KiB
Plaintext
--
|
|
:api: put-datafeed
|
|
:request: PutDatafeedRequest
|
|
:response: PutDatafeedResponse
|
|
--
|
|
[id="{upid}-{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
|
|
as a request and returns a +{response}+.
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Put Datafeed Request
|
|
|
|
A +{request}+ requires the following argument:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
<1> The configuration of the {ml} datafeed to create
|
|
|
|
[id="{upid}-{api}-config"]
|
|
==== Datafeed Configuration
|
|
|
|
The `DatafeedConfig` object contains all the details about the {ml} datafeed
|
|
configuration.
|
|
|
|
A `DatafeedConfig` requires the following arguments:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
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
|
|
|
|
==== Optional Arguments
|
|
The following arguments are optional:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-config-set-chunking-config]
|
|
--------------------------------------------------
|
|
<1> Specifies how data searches are split into time chunks.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
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.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-config-set-query]
|
|
--------------------------------------------------
|
|
<1> A query to filter the search results by. Defaults to the `match_all` query.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-config-set-query-delay]
|
|
--------------------------------------------------
|
|
<1> The time interval behind real time that data is queried.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-config-set-delayed-data-check-config]
|
|
--------------------------------------------------
|
|
<1> Sets the delayed data check configuration.
|
|
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.
|
|
To explicitly disable, pass `DelayedDataCheckConfig.disabledDelayedDataCheckConfig()`.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-config-set-script-fields]
|
|
--------------------------------------------------
|
|
<1> Allows the use of script fields.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-config-set-scroll-size]
|
|
--------------------------------------------------
|
|
<1> The `size` parameter used in the searches.
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Response
|
|
|
|
The returned +{response}+ returns the full representation of
|
|
the new {ml} datafeed if it has been successfully created. This will
|
|
contain the creation time and other fields initialized using
|
|
default values:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|
|
<1> The created datafeed
|