Class CompletionContext.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<CompletionContext.Builder>
co.elastic.clients.elasticsearch.core.search.CompletionContext.Builder
- All Implemented Interfaces:
WithJson<CompletionContext.Builder>
,ObjectBuilder<CompletionContext>
- Enclosing class:
- CompletionContext
public static class CompletionContext.Builder
extends WithJsonObjectBuilderBase<CompletionContext.Builder>
implements ObjectBuilder<CompletionContext>
Builder for
CompletionContext
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe factor by which the score of the suggestion should be boosted.build()
Builds aCompletionContext
.Required - The value of the category to filter/boost on.Required - The value of the category to filter/boost on.neighbours
(GeoHashPrecision value, GeoHashPrecision... values) An array of precision values at which neighboring geohashes should be taken into account.An array of precision values at which neighboring geohashes should be taken into account.neighbours
(List<GeoHashPrecision> list) An array of precision values at which neighboring geohashes should be taken into account.precision
(GeoHashPrecision value) The precision of the geohash to encode the query geo point.The precision of the geohash to encode the query geo point.Whether the category value should be treated as a prefix or not.protected CompletionContext.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
boost
The factor by which the score of the suggestion should be boosted. The score is computed by multiplying the boost with the suggestion weight.API name:
boost
-
context
Required - The value of the category to filter/boost on.API name:
context
-
context
Required - The value of the category to filter/boost on.API name:
context
-
neighbours
An array of precision values at which neighboring geohashes should be taken into account. Precision value can be a distance value (5m
,10km
, etc.) or a raw geohash precision (1
..12
). Defaults to generating neighbors for index time precision level.API name:
neighbours
Adds all elements of
list
toneighbours
. -
neighbours
public final CompletionContext.Builder neighbours(GeoHashPrecision value, GeoHashPrecision... values) An array of precision values at which neighboring geohashes should be taken into account. Precision value can be a distance value (5m
,10km
, etc.) or a raw geohash precision (1
..12
). Defaults to generating neighbors for index time precision level.API name:
neighbours
Adds one or more values to
neighbours
. -
neighbours
public final CompletionContext.Builder neighbours(Function<GeoHashPrecision.Builder, ObjectBuilder<GeoHashPrecision>> fn) An array of precision values at which neighboring geohashes should be taken into account. Precision value can be a distance value (5m
,10km
, etc.) or a raw geohash precision (1
..12
). Defaults to generating neighbors for index time precision level.API name:
neighbours
Adds a value to
neighbours
using a builder lambda. -
precision
The precision of the geohash to encode the query geo point. Can be specified as a distance value (5m
,10km
, etc.), or as a raw geohash precision (1
..12
). Defaults to index time precision level.API name:
precision
-
precision
public final CompletionContext.Builder precision(Function<GeoHashPrecision.Builder, ObjectBuilder<GeoHashPrecision>> fn) The precision of the geohash to encode the query geo point. Can be specified as a distance value (5m
,10km
, etc.), or as a raw geohash precision (1
..12
). Defaults to index time precision level.API name:
precision
-
prefix
Whether the category value should be treated as a prefix or not.API name:
prefix
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<CompletionContext.Builder>
-
build
Builds aCompletionContext
.- Specified by:
build
in interfaceObjectBuilder<CompletionContext>
- Throws:
NullPointerException
- if some of the required fields are null.
-