mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-10 15:05:33 +00:00
da5aeb8be7
Adds a "node" field to the response from the following endpoints: 1. Open anomaly detection job 2. Start datafeed 3. Start data frame analytics job If the job or datafeed is assigned to a node immediately then this field will return the ID of that node. In the case where a job or datafeed is opened or started lazily the node field will contain an empty string. Clients that want to test whether a job or datafeed was opened or started lazily can therefore check for this. Backport of #55473
39 lines
1.3 KiB
Plaintext
39 lines
1.3 KiB
Plaintext
--
|
|
:api: start-data-frame-analytics
|
|
:request: StartDataFrameAnalyticsRequest
|
|
:response: AcknowledgedResponse
|
|
--
|
|
[role="xpack"]
|
|
[id="{upid}-{api}"]
|
|
=== Start {dfanalytics-jobs} API
|
|
|
|
Starts an existing {dfanalytics-job}.
|
|
It accepts a +{request}+ object and responds with a +{response}+ object.
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Start {dfanalytics-job} request
|
|
|
|
A +{request}+ object requires a {dfanalytics-job} ID.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
---------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
---------------------------------------------------
|
|
<1> Constructing a new start request referencing an existing {dfanalytics-job}
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Start {dfanalytics-job} response
|
|
|
|
The returned +{response}+ object acknowledges the {dfanalytics-job} has started.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|
|
<1> `getNode()` returns the node that the job was assigned to. If the
|
|
job is allowed to open lazily and has not yet been assigned to a node
|
|
then an empty string is returned. If `getNode()` returns `null` then
|
|
the server is an old version that does not return node information.
|