Package co.elastic.clients.elasticsearch.cat

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final MlJobsRequest.Builder	allowNoJobs(Boolean value)	Deprecated. 7.10.0 Use allow_no_match instead.
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.
MlJobsRequest	build()	Builds a MlJobsRequest.
final MlJobsRequest.Builder	bytes(Bytes value)	The unit used to display byte values.
final MlJobsRequest.Builder	format(String value)	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	help(Boolean value)	If true, the response includes help information.
final MlJobsRequest.Builder	jobId(String value)	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	time(TimeUnit value)	The unit used to display time values.
final MlJobsRequest.Builder	v(Boolean value)	If true, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

allowNoJobs

@Deprecated
public final MlJobsRequest.Builder allowNoJobs(@Nullable
 Boolean value)

Deprecated.

7.10.0 Use allow_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

public final MlJobsRequest.Builder allowNoMatch(@Nullable
 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.

If true, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.

API name: allow_no_match

bytes

public final MlJobsRequest.Builder bytes(@Nullable
 Bytes value)

The unit used to display byte values.

API name: bytes

format

public final MlJobsRequest.Builder format(@Nullable
 String value)

Short version of the HTTP accept header. Valid values include JSON, YAML, for example.

API name: format

h

public final MlJobsRequest.Builder h(List<CatAnomalyDetectorColumn> list)

Comma-separated list of column names to display.

API name: h

Adds all elements of list to h.

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

public final MlJobsRequest.Builder help(@Nullable
 Boolean value)

If true, the response includes help information.

API name: help

jobId

public final MlJobsRequest.Builder jobId(@Nullable
 String value)

Identifier for the anomaly detection job.

API name: job_id

s

public final MlJobsRequest.Builder s(List<CatAnomalyDetectorColumn> list)

Comma-separated list of column names or column aliases used to sort the response.

API name: s

Adds all elements of list to s.

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

public final MlJobsRequest.Builder time(@Nullable
 TimeUnit value)

The unit used to display time values.

API name: time

v

public final MlJobsRequest.Builder v(@Nullable
 Boolean value)

If true, the response includes column headings.

API name: v

self

protected MlJobsRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<MlJobsRequest.Builder>

build

public MlJobsRequest build()

Builds a MlJobsRequest.

Specified by:

build in interface ObjectBuilder<MlJobsRequest>

Throws:

NullPointerException - if some of the required fields are null.