Package co.elastic.clients.elasticsearch.ml

Class UpdateTrainedModelDeploymentRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.UpdateTrainedModelDeploymentRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class UpdateTrainedModelDeploymentRequest
extends RequestBase
implements JsonpSerializable

Update a trained model deployment.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 final JsonpDeserializer<UpdateTrainedModelDeploymentRequest>	_DESERIALIZER	Json deserializer for UpdateTrainedModelDeploymentRequest
static final Endpoint<UpdateTrainedModelDeploymentRequest,UpdateTrainedModelDeploymentResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.update_trained_model_deployment".

Method Summary

Modifier and Type	Method	Description
final AdaptiveAllocationsSettings	adaptiveAllocations()	Adaptive allocations configuration.
final String	modelId()	Required - The unique identifier of the trained model.
final Integer	numberOfAllocations()	The number of model allocations on each node where the model is deployed.
static UpdateTrainedModelDeploymentRequest	of(Function<UpdateTrainedModelDeploymentRequest.Builder,ObjectBuilder<UpdateTrainedModelDeploymentRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupUpdateTrainedModelDeploymentRequestDeserializer(ObjectDeserializer<UpdateTrainedModelDeploymentRequest.Builder> op)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<UpdateTrainedModelDeploymentRequest> _DESERIALIZER

Json deserializer for UpdateTrainedModelDeploymentRequest

_ENDPOINT

public static final Endpoint<UpdateTrainedModelDeploymentRequest,UpdateTrainedModelDeploymentResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.update_trained_model_deployment".

Method Details

of

public static UpdateTrainedModelDeploymentRequest of(Function<UpdateTrainedModelDeploymentRequest.Builder,ObjectBuilder<UpdateTrainedModelDeploymentRequest>> fn)

adaptiveAllocations

@Nullable
public final AdaptiveAllocationsSettings adaptiveAllocations()

Adaptive allocations configuration. When enabled, the number of allocations is set based on the current load. If adaptive_allocations is enabled, do not set the number of allocations manually.

API name: adaptive_allocations

modelId

public final String modelId()

Required - The unique identifier of the trained model. Currently, only PyTorch models are supported.

API name: model_id

numberOfAllocations

@Nullable
public final Integer numberOfAllocations()

The number of model allocations on each node where the model is deployed. All allocations on a node share the same copy of the model in memory but use a separate set of threads to evaluate the model. Increasing this value generally increases the throughput. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads. If adaptive_allocations is enabled, do not set this value, because it’s automatically set.

API name: number_of_allocations

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupUpdateTrainedModelDeploymentRequestDeserializer

protected static void setupUpdateTrainedModelDeploymentRequestDeserializer(ObjectDeserializer<UpdateTrainedModelDeploymentRequest.Builder> op)