Package co.elastic.clients.elasticsearch.cat

Class MlTrainedModelsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.MlTrainedModelsRequest

public class MlTrainedModelsRequest
extends CatRequestBase

Returns configuration and usage information about inference trained models.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.

See Also:

API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MlTrainedModelsRequest.Builder	Builder for MlTrainedModelsRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<MlTrainedModelsRequest,MlTrainedModelsResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.ml_trained_models".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoMatch()	Whether to ignore if a wildcard expression matches no trained models.
Bytes	bytes()	The unit in which to display byte values
java.lang.Integer	from()	skips a number of trained models
java.util.List<CatTrainedModelsColumn>	h()	Comma-separated list of column names to display
java.lang.String	modelId()	The ID of the trained models stats to fetch
static MlTrainedModelsRequest	of(java.util.function.Function<MlTrainedModelsRequest.Builder,ObjectBuilder<MlTrainedModelsRequest>> fn)
java.util.List<CatTrainedModelsColumn>	s()	Comma-separated list of column names or column aliases to sort by
java.lang.Integer	size()	specifies a max number of trained models to get

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final Endpoint<MlTrainedModelsRequest,MlTrainedModelsResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.ml_trained_models".

Method Details

of

public static MlTrainedModelsRequest of(java.util.function.Function<MlTrainedModelsRequest.Builder,ObjectBuilder<MlTrainedModelsRequest>> fn)

allowNoMatch

@Nullable
public final java.lang.Boolean allowNoMatch()

Whether to ignore if a wildcard expression matches no trained models. (This includes _all string or when no trained models have been specified)

API name: allow_no_match

bytes

@Nullable
public final Bytes bytes()

The unit in which to display byte values

API name: bytes

from

@Nullable
public final java.lang.Integer from()

skips a number of trained models

API name: from

h

public final java.util.List<CatTrainedModelsColumn> h()

Comma-separated list of column names to display

API name: h

modelId

@Nullable
public final java.lang.String modelId()

The ID of the trained models stats to fetch

API name: model_id

s

public final java.util.List<CatTrainedModelsColumn> s()

Comma-separated list of column names or column aliases to sort by

API name: s

size

@Nullable
public final java.lang.Integer size()

specifies a max number of trained models to get

API name: size