Package co.elastic.clients.elasticsearch._types.mapping

Class SparseVectorIndexOptions.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<SparseVectorIndexOptions.Builder>

co.elastic.clients.elasticsearch._types.mapping.SparseVectorIndexOptions.Builder

All Implemented Interfaces:

WithJson<SparseVectorIndexOptions.Builder>, ObjectBuilder<SparseVectorIndexOptions>

Enclosing class:

SparseVectorIndexOptions

public static class SparseVectorIndexOptions.Builder
extends WithJsonObjectBuilderBase<SparseVectorIndexOptions.Builder>
implements ObjectBuilder<SparseVectorIndexOptions>

Builder for SparseVectorIndexOptions.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SparseVectorIndexOptions	build()	Builds a SparseVectorIndexOptions.
final SparseVectorIndexOptions.Builder	prune(Boolean value)	Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance.
final SparseVectorIndexOptions.Builder	pruningConfig(TokenPruningConfig value)	Optional pruning configuration.
final SparseVectorIndexOptions.Builder	pruningConfig(Function<TokenPruningConfig.Builder,ObjectBuilder<TokenPruningConfig>> fn)	Optional pruning configuration.
protected SparseVectorIndexOptions.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

prune

public final SparseVectorIndexOptions.Builder prune(@Nullable
 Boolean value)

Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance. If prune is true but the pruning_config is not specified, pruning will occur but default values will be used. Default: false

API name: prune

pruningConfig

public final SparseVectorIndexOptions.Builder pruningConfig(@Nullable
 TokenPruningConfig value)

Optional pruning configuration. If enabled, this will omit non-significant tokens from the query in order to improve query performance. This is only used if prune is set to true. If prune is set to true but pruning_config is not specified, default values will be used.

API name: pruning_config

pruningConfig

public final SparseVectorIndexOptions.Builder pruningConfig(Function<TokenPruningConfig.Builder,ObjectBuilder<TokenPruningConfig>> fn)

Optional pruning configuration. If enabled, this will omit non-significant tokens from the query in order to improve query performance. This is only used if prune is set to true. If prune is set to true but pruning_config is not specified, default values will be used.

API name: pruning_config

self

protected SparseVectorIndexOptions.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<SparseVectorIndexOptions.Builder>

build

public SparseVectorIndexOptions build()

Builds a SparseVectorIndexOptions.

Specified by:

build in interface ObjectBuilder<SparseVectorIndexOptions>

Throws:

NullPointerException - if some of the required fields are null.