Package org.opensearch.search.suggest.completion.context

Class GeoContextMapping.Builder

java.lang.Object

org.opensearch.search.suggest.completion.context.ContextBuilder<GeoContextMapping>

org.opensearch.search.suggest.completion.context.GeoContextMapping.Builder

Enclosing class:

GeoContextMapping

public static class GeoContextMapping.Builder
extends ContextBuilder<GeoContextMapping>

Builder for geo context mapping

Opensearch.internal:

Field Summary

Fields inherited from class org.opensearch.search.suggest.completion.context.ContextBuilder

name

Constructor Summary

Constructors

Constructor	Description
Builder(String name)

Method Summary

Modifier and Type	Method	Description
GeoContextMapping	build()
GeoContextMapping.Builder	field(String fieldName)	Set the name of the field containing a geolocation to use
GeoContextMapping.Builder	precision(double meters)	Set the precision use o make suggestions
GeoContextMapping.Builder	precision(double precision, DistanceUnit unit)	Set the precision use o make suggestions
GeoContextMapping.Builder	precision(int level)	Set the precision use o make suggestions
GeoContextMapping.Builder	precision(String precision)	Set the precision use o make suggestions

Methods inherited from class org.opensearch.search.suggest.completion.context.ContextBuilder

category, geo

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(String name)

Method Details

precision

public GeoContextMapping.Builder precision(String precision)

Set the precision use o make suggestions

Parameters:

precision - precision as distance with DistanceUnit. Default: meters

Returns:

this

precision

public GeoContextMapping.Builder precision(double precision,
 DistanceUnit unit)

Set the precision use o make suggestions

Parameters:

precision - precision value

unit - DistanceUnit to use

Returns:

this

precision

public GeoContextMapping.Builder precision(double meters)

Set the precision use o make suggestions

Parameters:

meters - precision as distance in meters

Returns:

this

precision

public GeoContextMapping.Builder precision(int level)

Set the precision use o make suggestions

Parameters:

level - maximum length of geohashes

Returns:

this

field

public GeoContextMapping.Builder field(String fieldName)

Set the name of the field containing a geolocation to use

Parameters:

fieldName - name of the field

Returns:

this

build

public GeoContextMapping build()

Specified by:

build in class ContextBuilder<GeoContextMapping>