Package co.elastic.clients.elasticsearch.ml

Class GetTrainedModelsStatsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.GetTrainedModelsStatsRequest

public class GetTrainedModelsStatsRequest
extends RequestBase

Retrieves usage information for trained models. You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetTrainedModelsStatsRequest,GetTrainedModelsStatsResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.get_trained_models_stats".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoMatch()	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.
final Integer	from()	Skips the specified number of models.
final String	modelId()	The unique identifier of the trained model or a model alias.
static GetTrainedModelsStatsRequest	of(Function<GetTrainedModelsStatsRequest.Builder,ObjectBuilder<GetTrainedModelsStatsRequest>> fn)
final Integer	size()	Specifies the maximum number of models to obtain.

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<GetTrainedModelsStatsRequest,GetTrainedModelsStatsResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.get_trained_models_stats".

Method Details

of

public static GetTrainedModelsStatsRequest of(Function<GetTrainedModelsStatsRequest.Builder,ObjectBuilder<GetTrainedModelsStatsRequest>> fn)

allowNoMatch

@Nullable
public final Boolean allowNoMatch()

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, it returns an empty array when there are no matches and the subset of results when there are partial matches.

API name: allow_no_match

from

@Nullable
public final Integer from()

Skips the specified number of models.

API name: from

modelId

@Nullable
public final String modelId()

The unique identifier of the trained model or a model alias.

API name: model_id

size

@Nullable
public final Integer size()

Specifies the maximum number of models to obtain.

API name: size