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
-
Method Summary
Modifier and TypeMethodDescriptionallowNoMatch
(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.build()
Builds aGetTrainedModelsRequest
.decompressDefinition
(Boolean value) Specifies whether the included model definition should be returned as a JSON map (true) or in a custom compressed format (false).excludeGenerated
(Boolean value) Indicates if certain fields should be removed from the configuration on retrieval.Skips the specified number of models.A comma delimited string of optional fields to include in the response body.The unique identifier of the trained model.protected GetTrainedModelsRequest.Builder
self()
Specifies the maximum number of models to obtain.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
-
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
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
Skips the specified number of models.API name:
from
-
include
A comma delimited string of optional fields to include in the response body.API name:
include
-
modelId
The unique identifier of the trained model.API name:
model_id
-
size
Specifies the maximum number of models to obtain.API name:
size
-
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
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetTrainedModelsRequest.Builder>
-
build
Builds aGetTrainedModelsRequest
.- Specified by:
build
in interfaceObjectBuilder<GetTrainedModelsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-