Package org.opensearch.client.opensearch._types.mapping

Class KnnVectorProperty

java.lang.Object

org.opensearch.client.opensearch._types.mapping.PropertyBase

org.opensearch.client.opensearch._types.mapping.CorePropertyBase

org.opensearch.client.opensearch._types.mapping.DocValuesPropertyBase

org.opensearch.client.opensearch._types.mapping.KnnVectorProperty

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, PropertyVariant, ToCopyableBuilder<KnnVectorProperty.Builder,KnnVectorProperty>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class KnnVectorProperty
extends DocValuesPropertyBase
implements PropertyVariant, ToCopyableBuilder<KnnVectorProperty.Builder,KnnVectorProperty>

Nested Class Summary

Nested Classes

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

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

DocValuesPropertyBase.AbstractBuilder<BuilderT extends DocValuesPropertyBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Property.Kind	_propertyKind()	Property variant kind.
static KnnVectorProperty.Builder	builder()
final String	compressionLevel()	API name: compression_level
final String	dataType()	API name: data_type
final int	dimension()	Required - API name: dimension
boolean	equals(Object o)
int	hashCode()
final KnnVectorMethod	method()	API name: method
final String	mode()	API name: mode
final String	modelId()	API name: model_id
static KnnVectorProperty	of(Function<KnnVectorProperty.Builder,ObjectBuilder<KnnVectorProperty>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupKnnVectorPropertyDeserializer(ObjectDeserializer<KnnVectorProperty.Builder> op)
final String	spaceType()	API name: space_type
KnnVectorProperty.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.mapping.DocValuesPropertyBase

docValues, setupDocValuesPropertyBaseDeserializer

Methods inherited from class org.opensearch.client.opensearch._types.mapping.CorePropertyBase

copyTo, setupCorePropertyBaseDeserializer, similarity, store

Methods inherited from class org.opensearch.client.opensearch._types.mapping.PropertyBase

dynamic, fields, ignoreAbove, meta, properties, serialize, setupPropertyBaseDeserializer

Methods inherited from class java.lang.Object

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

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

serialize

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

toJsonString

Methods inherited from interface org.opensearch.client.opensearch._types.mapping.PropertyVariant

toProperty

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<KnnVectorProperty> _DESERIALIZER

Json deserializer for KnnVectorProperty

Method Details

of

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

_propertyKind

public Property.Kind _propertyKind()

Property variant kind.

Specified by:

_propertyKind in interface PropertyVariant

compressionLevel

@Nullable
public final String compressionLevel()

API name: compression_level

dataType

@Nullable
public final String dataType()

API name: data_type

dimension

public final int dimension()

Required - API name: dimension

method

@Nullable
public final KnnVectorMethod method()

API name: method

mode

@Nullable
public final String mode()

API name: mode

modelId

@Nullable
public final String modelId()

API name: model_id

spaceType

@Nullable
public final String spaceType()

API name: space_type

serializeInternal

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

Overrides:

serializeInternal in class DocValuesPropertyBase

toBuilder

@Nonnull
public KnnVectorProperty.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<KnnVectorProperty.Builder,KnnVectorProperty>

Returns:

a new builder instance.

builder

@Nonnull
public static KnnVectorProperty.Builder builder()

setupKnnVectorPropertyDeserializer

protected static void setupKnnVectorPropertyDeserializer(ObjectDeserializer<KnnVectorProperty.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class DocValuesPropertyBase

equals

public boolean equals(Object o)

Overrides:

equals in class DocValuesPropertyBase