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
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aGeoDistanceQuery
.final GeoDistanceQuery.Builder
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
Required -final GeoDistanceQuery.Builder
location
(GeoLocation value) Required -final GeoDistanceQuery.Builder
Required -protected GeoDistanceQuery.Builder
self()
final GeoDistanceQuery.Builder
Set toIGNORE_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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
field
Required - -
location
Required - -
location
public final GeoDistanceQuery.Builder location(Function<GeoLocation.Builder, ObjectBuilder<GeoLocation>> fn) Required - -
distance
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
How to compute the distance. Set toplane
for a faster calculation that's inaccurate on long distances and close to the poles.API name:
distance_type
-
validationMethod
Set toIGNORE_MALFORMED
to accept geo points with invalid latitude or longitude. Set toCOERCE
to also try to infer correct latitude or longitude.API name:
validation_method
-
self
- Specified by:
self
in classQueryBase.AbstractBuilder<GeoDistanceQuery.Builder>
-
build
Builds aGeoDistanceQuery
.- Specified by:
build
in interfaceObjectBuilder<GeoDistanceQuery>
- Throws:
NullPointerException
- if some of the required fields are null.
-