Class GetJobsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetJobsRequest
public class GetJobsRequest extends RequestBase
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:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetJobsRequest.Builder
Builder forGetJobsRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<GetJobsRequest,GetJobsResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.get_jobs
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
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.java.lang.Boolean
excludeGenerated()
Indicates if certain fields should be removed from the configuration on retrieval.java.util.List<java.lang.String>
jobId()
Identifier for the anomaly detection job.static GetJobsRequest
of(java.util.function.Function<GetJobsRequest.Builder,ObjectBuilder<GetJobsRequest>> fn)
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_ENDPOINT
Endpoint "ml.get_jobs
".
-
-
Method Details
-
of
public static GetJobsRequest of(java.util.function.Function<GetJobsRequest.Builder,ObjectBuilder<GetJobsRequest>> fn) -
allowNoMatch
@Nullable public final java.lang.Boolean 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
@Nullable public final java.lang.Boolean 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
public final java.util.List<java.lang.String> 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
-