Package co.elastic.clients.elasticsearch._types.query_dsl

Class GeoDistanceQuery.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.query_dsl.QueryBase.AbstractBuilder<GeoDistanceQuery.Builder>

co.elastic.clients.elasticsearch._types.query_dsl.GeoDistanceQuery.Builder

All Implemented Interfaces:

WithJson<GeoDistanceQuery.Builder>, ObjectBuilder<GeoDistanceQuery>

Enclosing class:

GeoDistanceQuery

public static class GeoDistanceQuery.Builder
extends QueryBase.AbstractBuilder<GeoDistanceQuery.Builder>
implements ObjectBuilder<GeoDistanceQuery>

Builder for GeoDistanceQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GeoDistanceQuery	build()	Builds a GeoDistanceQuery.
final GeoDistanceQuery.Builder	distance(String value)	Required - The radius of the circle centred on the specified location.
final GeoDistanceQuery.Builder	distanceType(GeoDistanceType value)	How to compute the distance.
final GeoDistanceQuery.Builder	field(String value)	Required -
final GeoDistanceQuery.Builder	ignoreUnmapped(Boolean value)	Set to true to ignore an unmapped field and not match any documents for this query.
final GeoDistanceQuery.Builder	location(GeoLocation value)	Required -
final GeoDistanceQuery.Builder	location(Function<GeoLocation.Builder,ObjectBuilder<GeoLocation>> fn)	Required -
protected GeoDistanceQuery.Builder	self()
final GeoDistanceQuery.Builder	validationMethod(GeoValidationMethod value)	Set to IGNORE_MALFORMED to accept geo points with invalid latitude or longitude.

Methods inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase.AbstractBuilder

boost, queryName

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

field

public final GeoDistanceQuery.Builder field(String value)

Required -

location

public final GeoDistanceQuery.Builder location(GeoLocation value)

Required -

location

public final GeoDistanceQuery.Builder location(Function<GeoLocation.Builder,ObjectBuilder<GeoLocation>> fn)

Required -

distance

public final GeoDistanceQuery.Builder distance(String value)

Required - The radius of the circle centred on the specified location. Points which fall into this circle are considered to be matches.

API name: distance

distanceType

public final GeoDistanceQuery.Builder distanceType(@Nullable
 GeoDistanceType value)

How to compute the distance. Set to plane for a faster calculation that's inaccurate on long distances and close to the poles.

API name: distance_type

validationMethod

public final GeoDistanceQuery.Builder validationMethod(@Nullable
 GeoValidationMethod value)

Set to IGNORE_MALFORMED to accept geo points with invalid latitude or longitude. Set to COERCE to also try to infer correct latitude or longitude.

API name: validation_method

ignoreUnmapped

public final GeoDistanceQuery.Builder ignoreUnmapped(@Nullable
 Boolean value)

Set to true to ignore an unmapped field and not match any documents for this query. Set to false to throw an exception if the field is not mapped.

API name: ignore_unmapped

self

protected GeoDistanceQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<GeoDistanceQuery.Builder>

build

public GeoDistanceQuery build()

Builds a GeoDistanceQuery.

Specified by:

build in interface ObjectBuilder<GeoDistanceQuery>

Throws:

NullPointerException - if some of the required fields are null.