Class MlJobsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<BuilderT>
co.elastic.clients.elasticsearch.cat.CatRequestBase.AbstractBuilder<MlJobsRequest.Builder>
co.elastic.clients.elasticsearch.cat.MlJobsRequest.Builder
- All Implemented Interfaces:
WithJson<MlJobsRequest.Builder>
,ObjectBuilder<MlJobsRequest>
- Enclosing class:
- MlJobsRequest
public static class MlJobsRequest.Builder
extends CatRequestBase.AbstractBuilder<MlJobsRequest.Builder>
implements ObjectBuilder<MlJobsRequest>
Builder for
MlJobsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal MlJobsRequest.Builder
allowNoJobs
(Boolean value) Deprecated.final MlJobsRequest.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 aMlJobsRequest
.final MlJobsRequest.Builder
The unit used to display byte values.final MlJobsRequest.Builder
Short version of the HTTP accept header.final MlJobsRequest.Builder
h
(CatAnomalyDetectorColumn value, CatAnomalyDetectorColumn... values) Comma-separated list of column names to display.final MlJobsRequest.Builder
h
(List<CatAnomalyDetectorColumn> list) Comma-separated list of column names to display.final MlJobsRequest.Builder
If true, the response includes help information.final MlJobsRequest.Builder
Identifier for the anomaly detection job.final MlJobsRequest.Builder
s
(CatAnomalyDetectorColumn value, CatAnomalyDetectorColumn... values) Comma-separated list of column names or column aliases used to sort the response.final MlJobsRequest.Builder
s
(List<CatAnomalyDetectorColumn> list) Comma-separated list of column names or column aliases used to sort the response.protected MlJobsRequest.Builder
self()
final MlJobsRequest.Builder
The unit used to display time values.final MlJobsRequest.Builder
Iftrue
, the response includes column headings.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.
If
true
, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. Iffalse
, the API returns a 404 status code when there are no matches or only partial matches.API name:
allow_no_match
-
bytes
The unit used to display byte values.API name:
bytes
-
format
Short version of the HTTP accept header. Valid values include JSON, YAML, for example.API name:
format
-
h
Comma-separated list of column names to display.API name:
h
Adds all elements of
list
toh
. -
h
public final MlJobsRequest.Builder h(CatAnomalyDetectorColumn value, CatAnomalyDetectorColumn... values) Comma-separated list of column names to display.API name:
h
Adds one or more values to
h
. -
help
If true, the response includes help information.API name:
help
-
jobId
Identifier for the anomaly detection job.API name:
job_id
-
s
Comma-separated list of column names or column aliases used to sort the response.API name:
s
Adds all elements of
list
tos
. -
s
public final MlJobsRequest.Builder s(CatAnomalyDetectorColumn value, CatAnomalyDetectorColumn... values) Comma-separated list of column names or column aliases used to sort the response.API name:
s
Adds one or more values to
s
. -
time
The unit used to display time values.API name:
time
-
v
Iftrue
, the response includes column headings.API name:
v
-
self
- Specified by:
self
in classCatRequestBase.AbstractBuilder<MlJobsRequest.Builder>
-
build
Builds aMlJobsRequest
.- Specified by:
build
in interfaceObjectBuilder<MlJobsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-
allow_no_match
instead.