Package co.elastic.clients.elasticsearch.ml

Class PutTrainedModelRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.PutTrainedModelRequest

All Implemented Interfaces:

ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class PutTrainedModelRequest
extends RequestBase
implements JsonpSerializable

Nested Class Summary

Nested Classes

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

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 JsonpDeserializer<PutTrainedModelRequest>	_DESERIALIZER	Json deserializer for PutTrainedModelRequest
static Endpoint<PutTrainedModelRequest,PutTrainedModelResponse,ElasticsearchError>	ENDPOINT	Endpoint "ml.put_trained_model".

Constructor Summary

Constructors

Constructor	Description
PutTrainedModelRequest(PutTrainedModelRequest.Builder builder)
PutTrainedModelRequest(java.util.function.Function<PutTrainedModelRequest.Builder,PutTrainedModelRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.String	compressedDefinition()	The compressed (GZipped and Base64 encoded) inference definition of the model.
Definition	definition()	The inference definition for the model.
java.lang.String	description()	A human-readable description of the inference trained model.
InferenceConfig	inferenceConfig()	Required - The default configuration for inference.
Input	input()	Required - The input field names for the model definition.
JsonData	metadata()	An object map that contains metadata about the model.
java.lang.String	modelId()	Required - The unique identifier of the trained model.
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	setupPutTrainedModelRequestDeserializer(DelegatingDeserializer<PutTrainedModelRequest.Builder> op)
java.util.List<java.lang.String>	tags()	An array of tags to organize the model.

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PutTrainedModelRequest> _DESERIALIZER

Json deserializer for PutTrainedModelRequest

ENDPOINT

public static final Endpoint<PutTrainedModelRequest,PutTrainedModelResponse,ElasticsearchError> ENDPOINT

Endpoint "ml.put_trained_model".

Constructor Details

PutTrainedModelRequest

public PutTrainedModelRequest(PutTrainedModelRequest.Builder builder)

PutTrainedModelRequest

public PutTrainedModelRequest(java.util.function.Function<PutTrainedModelRequest.Builder,PutTrainedModelRequest.Builder> fn)

Method Details

modelId

public java.lang.String modelId()

Required - The unique identifier of the trained model.

API name: model_id

compressedDefinition

@Nullable
public java.lang.String 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

definition

@Nullable
public Definition definition()

The inference definition for the model. If definition is specified, then compressed_definition cannot be specified.

API name: definition

description

@Nullable
public java.lang.String description()

A human-readable description of the inference trained model.

API name: description

inferenceConfig

public InferenceConfig 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

input

public Input input()

Required - The input field names for the model definition.

API name: input

metadata

@Nullable
public JsonData metadata()

An object map that contains metadata about the model.

API name: metadata

tags

@Nullable
public java.util.List<java.lang.String> tags()

An array of tags to organize the model.

API name: tags

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)

setupPutTrainedModelRequestDeserializer

protected static void setupPutTrainedModelRequestDeserializer(DelegatingDeserializer<PutTrainedModelRequest.Builder> op)