OpenSearch/docs/java-rest/high-level/ml/get-job.asciidoc

--
:api: get-job
:request: GetJobRequest
:response: GetJobResponse
--
[id="{upid}-{api}"]
=== Get {anomaly-jobs} API

Retrieves configuration information for {anomaly-jobs} in the cluster.
It accepts a +{request}+ object and responds with a +{response}+ object.

[id="{upid}-{api}-request"]
==== Get {anomaly-jobs} 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 {anomaly-jobs}.

["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
<1> Constructing a new request referencing existing `jobIds`. It can contain
wildcards.
<2> Whether to ignore if a wildcard expression matches no {anomaly-jobs}.
 (This includes `_all` string or when no jobs have been specified).

[id="{upid}-{api}-response"]
==== Get {anomaly-jobs} 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[]