Package co.elastic.clients.elasticsearch.ml

Class GetTrainedModelsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.GetTrainedModelsRequest

All Implemented Interfaces:

ElasticsearchCommonRequest

public final class GetTrainedModelsRequest
extends RequestBase

Nested Class Summary

Nested Classes

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

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 Endpoint<GetTrainedModelsRequest,GetTrainedModelsResponse,ElasticsearchError>	ENDPOINT	Endpoint "ml.get_trained_models".

Constructor Summary

Constructors

Constructor	Description
GetTrainedModelsRequest(GetTrainedModelsRequest.Builder builder)
GetTrainedModelsRequest(java.util.function.Function<GetTrainedModelsRequest.Builder,GetTrainedModelsRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.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.
java.lang.Boolean	decompressDefinition()	Specifies whether the included model definition should be returned as a JSON map (true) or in a custom compressed format (false).
java.lang.Boolean	excludeGenerated()	Indicates if certain fields should be removed from the configuration on retrieval.
java.lang.Integer	from()	Skips the specified number of models.
java.lang.String	include()	A comma delimited string of optional fields to include in the response body.
java.lang.String	modelId()	The unique identifier of the trained model.
java.lang.Integer	size()	Specifies the maximum number of models to obtain.
java.lang.String	tags()	A comma delimited string of tags.

Methods inherited from class java.lang.Object

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

Field Details

ENDPOINT

public static final Endpoint<GetTrainedModelsRequest,GetTrainedModelsResponse,ElasticsearchError> ENDPOINT

Endpoint "ml.get_trained_models".

Constructor Details

GetTrainedModelsRequest

public GetTrainedModelsRequest(GetTrainedModelsRequest.Builder builder)

GetTrainedModelsRequest

public GetTrainedModelsRequest(java.util.function.Function<GetTrainedModelsRequest.Builder,GetTrainedModelsRequest.Builder> fn)

Method Details

modelId

@Nullable
public java.lang.String modelId()

The unique identifier of the trained model.

API name: model_id

allowNoMatch

@Nullable
public java.lang.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.

API name: allow_no_match

decompressDefinition

@Nullable
public java.lang.Boolean decompressDefinition()

Specifies whether the included model definition should be returned as a JSON map (true) or in a custom compressed format (false).

API name: decompress_definition

excludeGenerated

@Nullable
public java.lang.Boolean excludeGenerated()

Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.

API name: exclude_generated

from

@Nullable
public java.lang.Integer from()

Skips the specified number of models.

API name: from

include

@Nullable
public java.lang.String include()

A comma delimited string of optional fields to include in the response body.

API name: include

size

@Nullable
public java.lang.Integer size()

Specifies the maximum number of models to obtain.

API name: size

tags

@Nullable
public java.lang.String tags()

A comma delimited string of tags. A trained model can have many tags, or none. When supplied, only trained models that contain all the supplied tags are returned.

API name: tags