Package co.elastic.clients.elasticsearch.cat

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

co.elastic.clients.elasticsearch.cat.MlTrainedModelsRequest.Builder

All Implemented Interfaces:

WithJson<MlTrainedModelsRequest.Builder>, ObjectBuilder<MlTrainedModelsRequest>

Enclosing class:

MlTrainedModelsRequest

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

Builder for MlTrainedModelsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final MlTrainedModelsRequest.Builder	allowNoMatch(Boolean value)	Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.
MlTrainedModelsRequest	build()	Builds a MlTrainedModelsRequest.
final MlTrainedModelsRequest.Builder	bytes(Bytes value)	Sets the units for columns that contain a byte-size value.
final MlTrainedModelsRequest.Builder	from(Integer value)	Skips the specified number of transforms.
final MlTrainedModelsRequest.Builder	h(CatTrainedModelsColumn value, CatTrainedModelsColumn... values)	A comma-separated list of column names to display.
final MlTrainedModelsRequest.Builder	h(List<CatTrainedModelsColumn> list)	A comma-separated list of column names to display.
final MlTrainedModelsRequest.Builder	modelId(String value)	A unique identifier for the trained model.
final MlTrainedModelsRequest.Builder	s(CatTrainedModelsColumn value, CatTrainedModelsColumn... values)	A comma-separated list of column names or aliases used to sort the response.
final MlTrainedModelsRequest.Builder	s(List<CatTrainedModelsColumn> list)	A comma-separated list of column names or aliases used to sort the response.
protected MlTrainedModelsRequest.Builder	self()
final MlTrainedModelsRequest.Builder	size(Integer value)	The maximum number of transforms to display.
final MlTrainedModelsRequest.Builder	time(TimeUnit value)	Sets the units for columns that contain a time duration.

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 MlTrainedModelsRequest.Builder allowNoMatch(@Nullable
 Boolean value)

Specifies what to do when the request: contains wildcard expressions and there are no models 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 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 MlTrainedModelsRequest.Builder bytes(@Nullable
 Bytes value)

Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

API name: bytes

from

public final MlTrainedModelsRequest.Builder from(@Nullable
 Integer value)

Skips the specified number of transforms.

API name: from

h

public final MlTrainedModelsRequest.Builder h(List<CatTrainedModelsColumn> list)

A comma-separated list of column names to display.

API name: h

Adds all elements of list to h.

h

public final MlTrainedModelsRequest.Builder h(CatTrainedModelsColumn value,
 CatTrainedModelsColumn... values)

A comma-separated list of column names to display.

API name: h

Adds one or more values to h.

modelId

public final MlTrainedModelsRequest.Builder modelId(@Nullable
 String value)

A unique identifier for the trained model.

API name: model_id

s

public final MlTrainedModelsRequest.Builder s(List<CatTrainedModelsColumn> list)

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

API name: s

Adds all elements of list to s.

s

public final MlTrainedModelsRequest.Builder s(CatTrainedModelsColumn value,
 CatTrainedModelsColumn... values)

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

API name: s

Adds one or more values to s.

size

public final MlTrainedModelsRequest.Builder size(@Nullable
 Integer value)

The maximum number of transforms to display.

API name: size

time

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

Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

API name: time

self

protected MlTrainedModelsRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<MlTrainedModelsRequest.Builder>

build

public MlTrainedModelsRequest build()

Builds a MlTrainedModelsRequest.

Specified by:

build in interface ObjectBuilder<MlTrainedModelsRequest>

Throws:

NullPointerException - if some of the required fields are null.