Package org.opensearch.client.opensearch.knn

Class KnnMethod

java.lang.Object

org.opensearch.client.opensearch.knn.KnnMethod

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<KnnMethod>	_DESERIALIZER	Json deserializer for KnnMethod

Method Summary

Modifier and Type	Method	Description
static KnnMethod.Builder	builder()
final String	engine()	API name: engine
boolean	equals(Object o)
int	hashCode()
final String	name()	Required - API name: name
static KnnMethod	of(Function<KnnMethod.Builder,ObjectBuilder<KnnMethod>> fn)
final Map<String,JsonData>	parameters()	API name: parameters
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	setupKnnMethodDeserializer(ObjectDeserializer<KnnMethod.Builder> op)
final String	spaceType()	API name: space_type
KnnMethod.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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<KnnMethod> _DESERIALIZER

Json deserializer for KnnMethod

Method Details

of

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

engine

@Nullable
public final String engine()

API name: engine

name

@Nonnull
public final String name()

Required - API name: name

parameters

@Nonnull
public final Map<String,JsonData> parameters()

API name: parameters

spaceType

@Nullable
public final String spaceType()

API name: space_type

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 KnnMethod.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<KnnMethod.Builder,KnnMethod>

Returns:

a new builder instance.

builder

@Nonnull
public static KnnMethod.Builder builder()

setupKnnMethodDeserializer

protected static void setupKnnMethodDeserializer(ObjectDeserializer<KnnMethod.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object