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

Class SparseVectorIndexOptions

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SparseVectorIndexOptions
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static SparseVectorIndexOptions	of(Function<SparseVectorIndexOptions.Builder,ObjectBuilder<SparseVectorIndexOptions>> fn)
final Boolean	prune()	Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance.
final TokenPruningConfig	pruningConfig()	Optional pruning configuration.
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	setupSparseVectorIndexOptionsDeserializer(ObjectDeserializer<SparseVectorIndexOptions.Builder> op)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<SparseVectorIndexOptions> _DESERIALIZER

Json deserializer for SparseVectorIndexOptions

Method Details

of

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

prune

@Nullable
public final Boolean prune()

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

@Nullable
public final TokenPruningConfig pruningConfig()

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

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)

toString

public String toString()

Overrides:

toString in class Object

setupSparseVectorIndexOptionsDeserializer

protected static void setupSparseVectorIndexOptionsDeserializer(ObjectDeserializer<SparseVectorIndexOptions.Builder> op)