Class GetJobsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetJobsRequest
Retrieves configuration information for anomaly detection jobs. You can get
information for multiple anomaly detection jobs in a single API request by
using a group name, a comma-separated list of jobs, or a wildcard expression.
You can get information for all anomaly detection jobs by using
_all
, by specifying *
as the
<job_id>
, or by omitting the <job_id>
.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<GetJobsRequest,
GetJobsResponse, ErrorResponse> Endpoint "ml.get_jobs
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Specifies what to do when the request: Contains wildcard expressions and there are no jobs that match. Contains the _all string or no identifiers and there are no matches. Contains wildcard expressions and there are only partial matches.final Boolean
Indicates if certain fields should be removed from the configuration on retrieval.jobId()
Identifier for the anomaly detection job.static GetJobsRequest
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "ml.get_jobs
".
-
-
Method Details
-
of
-
allowNoMatch
Specifies what to do when the request:- Contains wildcard expressions and there are no jobs that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches.
The default value is
true
, which returns an emptyjobs
array when there are no matches and the subset of results when there are partial matches. If this parameter isfalse
, the request returns a404
status code when there are no matches or only partial matches.API name:
allow_no_match
-
excludeGenerated
Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.API name:
exclude_generated
-
jobId
Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. If you do not specify one of these options, the API returns information for all anomaly detection jobs.API name:
job_id
-