Package co.elastic.clients.elasticsearch.cat

Class MlDatafeedsRequest.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<MlDatafeedsRequest.Builder>

co.elastic.clients.elasticsearch.cat.MlDatafeedsRequest.Builder

All Implemented Interfaces:

WithJson<MlDatafeedsRequest.Builder>, ObjectBuilder<MlDatafeedsRequest>

Enclosing class:

MlDatafeedsRequest

public static class MlDatafeedsRequest.Builder
extends CatRequestBase.AbstractBuilder<MlDatafeedsRequest.Builder>
implements ObjectBuilder<MlDatafeedsRequest>

Builder for MlDatafeedsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MlDatafeedsRequest.Builder	allowNoMatch(java.lang.Boolean value)	Specifies what to do when the request: Contains wildcard expressions and there are no datafeeds that match. Contains the _all string or no identifiers and there are no matches. Contains wildcard expressions and there are only partial matches.
MlDatafeedsRequest	build()	Builds a MlDatafeedsRequest.
MlDatafeedsRequest.Builder	datafeedId(java.lang.String value)	A numerical character string that uniquely identifies the datafeed.
MlDatafeedsRequest.Builder	h(CatDatafeedColumn value, CatDatafeedColumn... values)	Comma-separated list of column names to display.
MlDatafeedsRequest.Builder	h(java.util.List<CatDatafeedColumn> list)	Comma-separated list of column names to display.
MlDatafeedsRequest.Builder	s(CatDatafeedColumn value, CatDatafeedColumn... values)	Comma-separated list of column names or column aliases used to sort the response.
MlDatafeedsRequest.Builder	s(java.util.List<CatDatafeedColumn> list)	Comma-separated list of column names or column aliases used to sort the response.
protected MlDatafeedsRequest.Builder	self()
MlDatafeedsRequest.Builder	time(TimeUnit value)	The unit used to display time values.

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

allowNoMatch

public final MlDatafeedsRequest.Builder allowNoMatch(@Nullable
java.lang.Boolean value)

Specifies what to do when the request:

• Contains wildcard expressions and there are no datafeeds 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 datafeeds 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

datafeedId

public final MlDatafeedsRequest.Builder datafeedId(@Nullable
java.lang.String value)

A numerical character string that uniquely identifies the datafeed.

API name: datafeed_id

h

public final MlDatafeedsRequest.Builder h(java.util.List<CatDatafeedColumn> list)

Comma-separated list of column names to display.

API name: h

Adds all elements of list to h.

h

public final MlDatafeedsRequest.Builder h(CatDatafeedColumn value,
CatDatafeedColumn... values)

Comma-separated list of column names to display.

API name: h

Adds one or more values to h.

s

public final MlDatafeedsRequest.Builder s(java.util.List<CatDatafeedColumn> 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 MlDatafeedsRequest.Builder s(CatDatafeedColumn value,
CatDatafeedColumn... 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 MlDatafeedsRequest.Builder time(@Nullable
TimeUnit value)

The unit used to display time values.

API name: time

self

protected MlDatafeedsRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<MlDatafeedsRequest.Builder>

build

public MlDatafeedsRequest build()

Builds a MlDatafeedsRequest.

Specified by:

build in interface ObjectBuilder<MlDatafeedsRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.