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

Class GeoDistanceQuery

java.lang.Object

co.elastic.clients.elasticsearch._types.query_dsl.QueryBase

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

All Implemented Interfaces:

QueryVariant, JsonpSerializable

@JsonpDeserializable
public class GeoDistanceQuery
extends QueryBase
implements QueryVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase

QueryBase.AbstractBuilder<BuilderT extends QueryBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Query.Kind	_queryKind()	Query variant kind.
final String	distance()	Required - The radius of the circle centred on the specified location.
final GeoDistanceType	distanceType()	How to compute the distance.
final String	field()	Required -
final Boolean	ignoreUnmapped()	Set to true to ignore an unmapped field and not match any documents for this query.
final GeoLocation	location()	Required -
static GeoDistanceQuery	of(Function<GeoDistanceQuery.Builder,ObjectBuilder<GeoDistanceQuery>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupGeoDistanceQueryDeserializer(ObjectDeserializer<GeoDistanceQuery.Builder> op)
final GeoValidationMethod	validationMethod()	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

boost, queryName, serialize, setupQueryBaseDeserializer, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch._types.query_dsl.QueryVariant

_toQuery

Field Details

_DESERIALIZER

public static final JsonpDeserializer<GeoDistanceQuery> _DESERIALIZER

Json deserializer for GeoDistanceQuery

Method Details

of

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

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

field

public final String field()

Required -

location

public final GeoLocation location()

Required -

distance

public final String 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

@Nullable
public final GeoDistanceType distanceType()

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

@Nullable
public final GeoValidationMethod validationMethod()

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

@Nullable
public final Boolean ignoreUnmapped()

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

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class QueryBase

setupGeoDistanceQueryDeserializer

protected static void setupGeoDistanceQueryDeserializer(ObjectDeserializer<GeoDistanceQuery.Builder> op)