Class PutTrainedModelRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.ml.PutTrainedModelRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<PutTrainedModelRequest>
- Enclosing class:
- PutTrainedModelRequest
public static class PutTrainedModelRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<PutTrainedModelRequest>
Builder for
PutTrainedModelRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description PutTrainedModelRequest
build()
Builds aPutTrainedModelRequest
.PutTrainedModelRequest.Builder
compressedDefinition(java.lang.String value)
The compressed (GZipped and Base64 encoded) inference definition of the model.PutTrainedModelRequest.Builder
deferDefinitionDecompression(java.lang.Boolean value)
If set totrue
and acompressed_definition
is provided, the request defers definition decompression and skips relevant validations.PutTrainedModelRequest.Builder
definition(Definition value)
The inference definition for the model.PutTrainedModelRequest.Builder
definition(java.util.function.Function<Definition.Builder,ObjectBuilder<Definition>> fn)
The inference definition for the model.PutTrainedModelRequest.Builder
description(java.lang.String value)
A human-readable description of the inference trained model.PutTrainedModelRequest.Builder
inferenceConfig(InferenceConfig value)
Required - The default configuration for inference.PutTrainedModelRequest.Builder
inferenceConfig(java.util.function.Function<InferenceConfig.Builder,ObjectBuilder<InferenceConfig>> fn)
Required - The default configuration for inference.PutTrainedModelRequest.Builder
input(Input value)
Required - The input field names for the model definition.PutTrainedModelRequest.Builder
input(java.util.function.Function<Input.Builder,ObjectBuilder<Input>> fn)
Required - The input field names for the model definition.PutTrainedModelRequest.Builder
metadata(JsonData value)
An object map that contains metadata about the model.PutTrainedModelRequest.Builder
modelId(java.lang.String value)
Required - The unique identifier of the trained model.PutTrainedModelRequest.Builder
modelSizeBytes(java.lang.Long value)
The estimated memory usage in bytes to keep the trained model in memory.PutTrainedModelRequest.Builder
modelType(TrainedModelType value)
The model type.PutTrainedModelRequest.Builder
tags(java.lang.String value, java.lang.String... values)
An array of tags to organize the model.PutTrainedModelRequest.Builder
tags(java.util.List<java.lang.String> list)
An array of tags to organize the model.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
-
compressedDefinition
The compressed (GZipped and Base64 encoded) inference definition of the model. If compressed_definition is specified, then definition cannot be specified.API name:
compressed_definition
-
deferDefinitionDecompression
public final PutTrainedModelRequest.Builder deferDefinitionDecompression(@Nullable java.lang.Boolean value)If set totrue
and acompressed_definition
is provided, the request defers definition decompression and skips relevant validations.API name:
defer_definition_decompression
-
definition
The inference definition for the model. If definition is specified, then compressed_definition cannot be specified.API name:
definition
-
definition
public final PutTrainedModelRequest.Builder definition(java.util.function.Function<Definition.Builder,ObjectBuilder<Definition>> fn)The inference definition for the model. If definition is specified, then compressed_definition cannot be specified.API name:
definition
-
description
A human-readable description of the inference trained model.API name:
description
-
inferenceConfig
Required - The default configuration for inference. This can be either a regression or classification configuration. It must match the underlying definition.trained_model's target_type.API name:
inference_config
-
inferenceConfig
public final PutTrainedModelRequest.Builder inferenceConfig(java.util.function.Function<InferenceConfig.Builder,ObjectBuilder<InferenceConfig>> fn)Required - The default configuration for inference. This can be either a regression or classification configuration. It must match the underlying definition.trained_model's target_type.API name:
inference_config
-
input
Required - The input field names for the model definition.API name:
input
-
input
public final PutTrainedModelRequest.Builder input(java.util.function.Function<Input.Builder,ObjectBuilder<Input>> fn)Required - The input field names for the model definition.API name:
input
-
metadata
An object map that contains metadata about the model.API name:
metadata
-
modelId
Required - The unique identifier of the trained model.API name:
model_id
-
modelSizeBytes
The estimated memory usage in bytes to keep the trained model in memory. This property is supported only if defer_definition_decompression is true or the model definition is not supplied.API name:
model_size_bytes
-
modelType
The model type.API name:
model_type
-
tags
An array of tags to organize the model.API name:
tags
Adds all elements of
list
totags
. -
tags
public final PutTrainedModelRequest.Builder tags(java.lang.String value, java.lang.String... values)An array of tags to organize the model.API name:
tags
Adds one or more values to
tags
. -
build
Builds aPutTrainedModelRequest
.- Specified by:
build
in interfaceObjectBuilder<PutTrainedModelRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-