Package org.opensearch.client.opensearch.knn

Class TrainModelRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<TrainModelRequest.Builder>

org.opensearch.client.opensearch.knn.TrainModelRequest.Builder

All Implemented Interfaces:

CopyableBuilder<TrainModelRequest.Builder,TrainModelRequest>, MutableBuilder<TrainModelRequest.Builder,TrainModelRequest>, ObjectBuilder<TrainModelRequest>

Enclosing class:

TrainModelRequest

public static class TrainModelRequest.Builder
extends RequestBase.AbstractBuilder<TrainModelRequest.Builder>
implements CopyableBuilder<TrainModelRequest.Builder,TrainModelRequest>

Builder for TrainModelRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TrainModelRequest	build()	Builds a TrainModelRequest.
final TrainModelRequest.Builder	compressionLevel(String value)	API name: compression_level
TrainModelRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final TrainModelRequest.Builder	description(String value)	API name: description
final TrainModelRequest.Builder	dimension(int value)	Required - API name: dimension
final TrainModelRequest.Builder	maxTrainingVectorCount(Integer value)	API name: max_training_vector_count
final TrainModelRequest.Builder	method(Function<KnnMethod.Builder,ObjectBuilder<KnnMethod>> fn)	API name: method
final TrainModelRequest.Builder	method(KnnMethod value)	API name: method
final TrainModelRequest.Builder	mode(String value)	API name: mode
final TrainModelRequest.Builder	modelId(String value)	The id of the model.
final TrainModelRequest.Builder	preference(String value)	Preferred node to execute training.
final TrainModelRequest.Builder	searchSize(Integer value)	API name: search_size
protected TrainModelRequest.Builder	self()
final TrainModelRequest.Builder	spaceType(String value)	API name: spaceType
final TrainModelRequest.Builder	trainingField(String value)	Required - API name: training_field
final TrainModelRequest.Builder	trainingIndex(String value)	Required - API name: training_index

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

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public TrainModelRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<TrainModelRequest.Builder,TrainModelRequest>

Returns:

a new builder instance.

self

@Nonnull
protected TrainModelRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<TrainModelRequest.Builder>

compressionLevel

@Nonnull
public final TrainModelRequest.Builder compressionLevel(@Nullable
 String value)

API name: compression_level

description

@Nonnull
public final TrainModelRequest.Builder description(@Nullable
 String value)

API name: description

dimension

@Nonnull
public final TrainModelRequest.Builder dimension(int value)

Required - API name: dimension

maxTrainingVectorCount

@Nonnull
public final TrainModelRequest.Builder maxTrainingVectorCount(@Nullable
 Integer value)

API name: max_training_vector_count

method

@Nonnull
public final TrainModelRequest.Builder method(@Nullable
 KnnMethod value)

API name: method

method

@Nonnull
public final TrainModelRequest.Builder method(Function<KnnMethod.Builder,ObjectBuilder<KnnMethod>> fn)

API name: method

mode

@Nonnull
public final TrainModelRequest.Builder mode(@Nullable
 String value)

API name: mode

modelId

@Nonnull
public final TrainModelRequest.Builder modelId(@Nullable
 String value)

The id of the model.

API name: model_id

preference

@Nonnull
public final TrainModelRequest.Builder preference(@Nullable
 String value)

Preferred node to execute training.

API name: preference

searchSize

@Nonnull
public final TrainModelRequest.Builder searchSize(@Nullable
 Integer value)

API name: search_size

spaceType

@Nonnull
public final TrainModelRequest.Builder spaceType(@Nullable
 String value)

API name: spaceType

trainingField

@Nonnull
public final TrainModelRequest.Builder trainingField(String value)

Required - API name: training_field

trainingIndex

@Nonnull
public final TrainModelRequest.Builder trainingIndex(String value)

Required - API name: training_index

build

@Nonnull
public TrainModelRequest build()

Builds a TrainModelRequest.

Specified by:

build in interface ObjectBuilder<TrainModelRequest>

Throws:

NullPointerException - if some of the required fields are null.