Class GetJobsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetJobsRequest.Builder>
co.elastic.clients.elasticsearch.ml.GetJobsRequest.Builder
- All Implemented Interfaces:
WithJson<GetJobsRequest.Builder>
,ObjectBuilder<GetJobsRequest>
- Enclosing class:
- GetJobsRequest
public static class GetJobsRequest.Builder
extends RequestBase.AbstractBuilder<GetJobsRequest.Builder>
implements ObjectBuilder<GetJobsRequest>
Builder for
GetJobsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal GetJobsRequest.Builder
allowNoJobs
(Boolean value) Deprecated.final GetJobsRequest.Builder
allowNoMatch
(Boolean value) 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.build()
Builds aGetJobsRequest
.final GetJobsRequest.Builder
excludeGenerated
(Boolean value) Indicates if certain fields should be removed from the configuration on retrieval.final GetJobsRequest.Builder
Identifier for the anomaly detection job.final GetJobsRequest.Builder
Identifier for the anomaly detection job.protected GetJobsRequest.Builder
self()
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowNoJobs
Deprecated.7.10.0 Useallow_no_match
instead.Whether to ignore if a wildcard expression matches no jobs. (This includes_all
string or when no jobs have been specified)API name:
allow_no_jobs
-
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
Adds all elements of
list
tojobId
. -
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
Adds one or more values to
jobId
. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetJobsRequest.Builder>
-
build
Builds aGetJobsRequest
.- Specified by:
build
in interfaceObjectBuilder<GetJobsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-
allow_no_match
instead.