Class GetTrainedModelsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.ml.GetTrainedModelsRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<GetTrainedModelsRequest>
- Enclosing class:
- GetTrainedModelsRequest
public static class GetTrainedModelsRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<GetTrainedModelsRequest>
Builder for
GetTrainedModelsRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description GetTrainedModelsRequest.Builder
allowNoMatch(java.lang.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 aGetTrainedModelsRequest
.GetTrainedModelsRequest.Builder
decompressDefinition(java.lang.Boolean value)
Specifies whether the included model definition should be returned as a JSON map (true) or in a custom compressed format (false).GetTrainedModelsRequest.Builder
excludeGenerated(java.lang.Boolean value)
Indicates if certain fields should be removed from the configuration on retrieval.GetTrainedModelsRequest.Builder
from(java.lang.Integer value)
Skips the specified number of models.GetTrainedModelsRequest.Builder
include(Include value)
A comma delimited string of optional fields to include in the response body.GetTrainedModelsRequest.Builder
modelId(java.lang.String value)
The unique identifier of the trained model.GetTrainedModelsRequest.Builder
size(java.lang.Integer value)
Specifies the maximum number of models to obtain.GetTrainedModelsRequest.Builder
tags(java.lang.String value)
A comma delimited string of tags.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
-
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
public final GetTrainedModelsRequest.Builder decompressDefinition(@Nullable java.lang.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
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
-
build
Builds aGetTrainedModelsRequest
.- Specified by:
build
in interfaceObjectBuilder<GetTrainedModelsRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-