Package org.opensearch.client.opensearch.knn

Class TrainModelRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.knn.TrainModelRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<TrainModelRequest.Builder,TrainModelRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class TrainModelRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<TrainModelRequest.Builder,TrainModelRequest>

Create and train a model that can be used for initializing k-NN native library indexes during indexing.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<TrainModelRequest>	_DESERIALIZER	Json deserializer for TrainModelRequest
static final Endpoint<TrainModelRequest,TrainModelResponse,ErrorResponse>	_ENDPOINT	Endpoint "knn.train_model".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static TrainModelRequest.Builder	builder()
final String	compressionLevel()	API name: compression_level
final String	description()	API name: description
final int	dimension()	Required - API name: dimension
boolean	equals(Object o)
int	hashCode()
final Integer	maxTrainingVectorCount()	API name: max_training_vector_count
final KnnMethod	method()	API name: method
final String	mode()	API name: mode
final String	modelId()	The id of the model.
static TrainModelRequest	of(Function<TrainModelRequest.Builder,ObjectBuilder<TrainModelRequest>> fn)
final String	preference()	Preferred node to execute training.
final Integer	searchSize()	API name: search_size
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	setupTrainModelRequestDeserializer(ObjectDeserializer<TrainModelRequest.Builder> op)
final String	spaceType()	API name: spaceType
TrainModelRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	trainingField()	Required - API name: training_field
final String	trainingIndex()	Required - API name: training_index

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TrainModelRequest> _DESERIALIZER

Json deserializer for TrainModelRequest

_ENDPOINT

public static final Endpoint<TrainModelRequest,TrainModelResponse,ErrorResponse> _ENDPOINT

Endpoint "knn.train_model".

Method Details

of

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

compressionLevel

@Nullable
public final String compressionLevel()

API name: compression_level

description

@Nullable
public final String description()

API name: description

dimension

public final int dimension()

Required - API name: dimension

maxTrainingVectorCount

@Nullable
public final Integer maxTrainingVectorCount()

API name: max_training_vector_count

method

@Nullable
public final KnnMethod method()

API name: method

mode

@Nullable
public final String mode()

API name: mode

modelId

@Nullable
public final String modelId()

The id of the model.

API name: model_id

preference

@Nullable
public final String preference()

Preferred node to execute training.

API name: preference

searchSize

@Nullable
public final Integer searchSize()

API name: search_size

spaceType

@Nullable
public final String spaceType()

API name: spaceType

trainingField

@Nonnull
public final String trainingField()

Required - API name: training_field

trainingIndex

@Nonnull
public final String trainingIndex()

Required - API name: training_index

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)

toBuilder

@Nonnull
public TrainModelRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<TrainModelRequest.Builder,TrainModelRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static TrainModelRequest.Builder builder()

setupTrainModelRequestDeserializer

protected static void setupTrainModelRequestDeserializer(ObjectDeserializer<TrainModelRequest.Builder> op)

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object