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

Class KnnVectorProperty.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.mapping.PropertyBase.AbstractBuilder<BuilderT>

org.opensearch.client.opensearch._types.mapping.CorePropertyBase.AbstractBuilder<BuilderT>

org.opensearch.client.opensearch._types.mapping.DocValuesPropertyBase.AbstractBuilder<KnnVectorProperty.Builder>

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

All Implemented Interfaces:

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

Enclosing class:

KnnVectorProperty

public static class KnnVectorProperty.Builder
extends DocValuesPropertyBase.AbstractBuilder<KnnVectorProperty.Builder>
implements CopyableBuilder<KnnVectorProperty.Builder,KnnVectorProperty>

Builder for KnnVectorProperty.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KnnVectorProperty	build()	Builds a KnnVectorProperty.
KnnVectorProperty.Builder	compressionLevel(java.lang.String value)	API name: compression_level
KnnVectorProperty.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
KnnVectorProperty.Builder	dataType(java.lang.String value)	API name: data_type
KnnVectorProperty.Builder	dimension(int value)	Required - API name: dimension
KnnVectorProperty.Builder	method(java.util.function.Function<KnnVectorMethod.Builder,ObjectBuilder<KnnVectorMethod>> fn)	API name: method
KnnVectorProperty.Builder	method(KnnVectorMethod value)	API name: method
KnnVectorProperty.Builder	mode(java.lang.String value)	API name: mode
KnnVectorProperty.Builder	modelId(java.lang.String value)	API name: model_id
protected KnnVectorProperty.Builder	self()
KnnVectorProperty.Builder	spaceType(java.lang.String value)	API name: space_type

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

docValues

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

copyTo, copyTo, similarity, store

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

dynamic, fields, fields, fields, ignoreAbove, localMetadata, localMetadata, meta, meta, name, properties, properties, properties

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

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _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 Detail

Builder

public Builder()

Method Detail

copy

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

Returns:

a new builder instance.

self

@Nonnull
protected KnnVectorProperty.Builder self()

Specified by:

self in class PropertyBase.AbstractBuilder<KnnVectorProperty.Builder>

compressionLevel

@Nonnull
public final KnnVectorProperty.Builder compressionLevel(@Nullable
                                                        java.lang.String value)

API name: compression_level

dataType

@Nonnull
public final KnnVectorProperty.Builder dataType(@Nullable
                                                java.lang.String value)

API name: data_type

dimension

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

Required - API name: dimension

method

@Nonnull
public final KnnVectorProperty.Builder method(@Nullable
                                              KnnVectorMethod value)

API name: method

method

@Nonnull
public final KnnVectorProperty.Builder method(java.util.function.Function<KnnVectorMethod.Builder,ObjectBuilder<KnnVectorMethod>> fn)

API name: method

mode

@Nonnull
public final KnnVectorProperty.Builder mode(@Nullable
                                            java.lang.String value)

API name: mode

modelId

@Nonnull
public final KnnVectorProperty.Builder modelId(@Nullable
                                               java.lang.String value)

API name: model_id

spaceType

@Nonnull
public final KnnVectorProperty.Builder spaceType(@Nullable
                                                 java.lang.String value)

API name: space_type

build

@Nonnull
public KnnVectorProperty build()

Builds a KnnVectorProperty.

Specified by:

build in interface ObjectBuilder<KnnVectorProperty>

Throws:

java.lang.NullPointerException - if some of the required fields are null.