mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 13:08:29 +00:00
6f5daadb3c
* 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
39 lines
1.3 KiB
Plaintext
39 lines
1.3 KiB
Plaintext
--
|
|
:api: get-job
|
|
:request: GetJobRequest
|
|
:response: GetJobResponse
|
|
--
|
|
[id="{upid}-{api}"]
|
|
=== Get Job API
|
|
|
|
The Get Job API provides the ability to get {ml} jobs in the cluster.
|
|
It accepts a +{request}+ object and responds
|
|
with a +{response}+ object.
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Get Job Request
|
|
|
|
A +{request}+ object gets can have any number of `jobId` or `groupName`
|
|
entries. However, they all must be non-null. An empty list is the same as
|
|
requesting for all jobs.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
<1> Constructing a new request referencing existing `jobIds`, can contain wildcards
|
|
<2> Whether to ignore if a wildcard expression matches no jobs.
|
|
(This includes `_all` string or when no jobs have been specified)
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Get Job Response
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|
|
<1> `getCount()` from the +{response}+ indicates the number of jobs found
|
|
<2> `getJobs()` is the collection of {ml} `Job` objects found
|
|
|
|
include::../execution.asciidoc[]
|