Package co.elastic.clients.elasticsearch.ml

Class GetTrainedModelsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetTrainedModelsRequest.Builder>

co.elastic.clients.elasticsearch.ml.GetTrainedModelsRequest.Builder

All Implemented Interfaces:

WithJson<GetTrainedModelsRequest.Builder>, ObjectBuilder<GetTrainedModelsRequest>

Enclosing class:

GetTrainedModelsRequest

public static class GetTrainedModelsRequest.Builder
extends RequestBase.AbstractBuilder<GetTrainedModelsRequest.Builder>
implements ObjectBuilder<GetTrainedModelsRequest>

Builder for GetTrainedModelsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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 GetTrainedModelsRequest.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, 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

decompressDefinition

public final GetTrainedModelsRequest.Builder decompressDefinition(@Nullable
 Boolean value)

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

public final GetTrainedModelsRequest.Builder excludeGenerated(@Nullable
 Boolean value)

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

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

Skips the specified number of models.

API name: from

include

public final GetTrainedModelsRequest.Builder include(@Nullable
 Include value)

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

API name: include

modelId

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

The unique identifier of the trained model.

API name: model_id

size

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

Specifies the maximum number of models to obtain.

API name: size

tags

public final GetTrainedModelsRequest.Builder tags(@Nullable
 String value)

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

self

protected GetTrainedModelsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetTrainedModelsRequest.Builder>

build

public GetTrainedModelsRequest build()

Builds a GetTrainedModelsRequest.

Specified by:

build in interface ObjectBuilder<GetTrainedModelsRequest>

Throws:

NullPointerException - if some of the required fields are null.