honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/java-rest/high-level/ml/open-job.asciidoc

42 lines
1.5 KiB
Plaintext
Raw Normal View History

Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
--
:api: open-job
:request: OpenJobRequest
:response: OpenJobResponse
--
[DOCS] Adds missing icons to ML HLRC APIs (#46515)
2019-09-10 11:26:56 -04:00
[role="xpack"]
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
[id="{upid}-{api}"]
[DOCS] Fix titles for ML APIs (#63152) (#63207)
2020-10-02 17:01:01 -04:00
=== Open {anomaly-jobs} API
HLRC: adding machine learning open job (#32860) * HLRC: adding machine learning open job HLRC: adding ML open job API call * Addressing @droberts195 comments and fixing minor style issue
2018-08-15 14:19:41 -04:00
[DOCS] Updates terms in anomaly detection job APIs (#44839)
2019-07-25 11:58:16 -04:00
Opens {anomaly-jobs} in the cluster. It accepts a +{request}+ object and
responds with a +{response}+ object.
HLRC: adding machine learning open job (#32860) * HLRC: adding machine learning open job HLRC: adding ML open job API call * Addressing @droberts195 comments and fixing minor style issue
2018-08-15 14:19:41 -04:00
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
[id="{upid}-{api}-request"]
[DOCS] Fix titles for ML APIs (#63152) (#63207)
2020-10-02 17:01:01 -04:00
==== Open {anomaly-jobs} request
HLRC: adding machine learning open job (#32860) * HLRC: adding machine learning open job HLRC: adding ML open job API call * Addressing @droberts195 comments and fixing minor style issue
2018-08-15 14:19:41 -04:00
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
An +{request}+ object gets created with an existing non-null `jobId`.
HLRC: adding machine learning open job (#32860) * HLRC: adding machine learning open job HLRC: adding ML open job API call * Addressing @droberts195 comments and fixing minor style issue
2018-08-15 14:19:41 -04:00
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
include-tagged::{doc-tests-file}[{api}-request]
HLRC: adding machine learning open job (#32860) * HLRC: adding machine learning open job HLRC: adding ML open job API call * Addressing @droberts195 comments and fixing minor style issue
2018-08-15 14:19:41 -04:00
--------------------------------------------------
<1> Constructing a new request referencing an existing `jobId`
<2> Optionally setting the `timeout` value for how long the
execution should wait for the job to be opened.
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
[id="{upid}-{api}-response"]
[DOCS] Fix titles for ML APIs (#63152) (#63207)
2020-10-02 17:01:01 -04:00
==== Open {anomaly-jobs} response
HLRC: adding machine learning open job (#32860) * HLRC: adding machine learning open job HLRC: adding ML open job API call * Addressing @droberts195 comments and fixing minor style issue
2018-08-15 14:19:41 -04:00
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Feature/hlrc ml docs cleanup (#34316) * HLRC: ML Add preview datafeed api * Changing deprecation handling for parser * Removing some duplication in docs, will address other APIs in another PR * HLRC: ML Cleanup docs * updating get datafeed stats docs
2018-10-05 11:45:46 -04:00
include-tagged::{doc-tests-file}[{api}-response]
HLRC: adding machine learning open job (#32860) * HLRC: adding machine learning open job HLRC: adding ML open job API call * Addressing @droberts195 comments and fixing minor style issue
2018-08-15 14:19:41 -04:00
--------------------------------------------------
[ML] Return assigned node in start/open job/datafeed response (#55570) 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
2020-04-22 07:06:53 -04:00
<1> `isOpened()` from the +{response}+ is always `true` if the job was
opened successfully. (An exception would be thrown instead if the job
was not opened successfully.)
<2> `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.
HLRC: adding machine learning open job (#32860) * HLRC: adding machine learning open job HLRC: adding ML open job API call * Addressing @droberts195 comments and fixing minor style issue
2018-08-15 14:19:41 -04:00
[ML] Return assigned node in start/open job/datafeed response (#55570) 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
2020-04-22 07:06:53 -04:00
include::../execution.asciidoc[]