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

Class DistanceFeatureQueryBase<TOrigin,TDistance>

java.lang.Object

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

co.elastic.clients.elasticsearch._types.query_dsl.DistanceFeatureQueryBase<TOrigin,TDistance>

All Implemented Interfaces:

JsonpSerializable

Direct Known Subclasses:

DateDistanceFeatureQuery, GeoDistanceFeatureQuery, UntypedDistanceFeatureQuery

public abstract class DistanceFeatureQueryBase<TOrigin,TDistance>
extends QueryBase

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DistanceFeatureQueryBase.AbstractBuilder<TOrigin,TDistance,BuilderT extends DistanceFeatureQueryBase.AbstractBuilder<TOrigin,TDistance,BuilderT>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DistanceFeatureQueryBase(DistanceFeatureQueryBase.AbstractBuilder<TOrigin,TDistance,?> builder)

Method Summary

Modifier and Type	Method	Description
final String	field()	Required - Name of the field used to calculate distances.
final TOrigin	origin()	Required - Date or point of origin used to calculate distances.
final TDistance	pivot()	Required - Distance from the origin at which relevance scores receive half of the boost value.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <TOrigin, TDistance, BuilderT extends DistanceFeatureQueryBase.AbstractBuilder<TOrigin, TDistance, BuilderT>> void	setupDistanceFeatureQueryBaseDeserializer(ObjectDeserializer<BuilderT> op, JsonpDeserializer<TOrigin> tOriginDeserializer, JsonpDeserializer<TDistance> tDistanceDeserializer)

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

Constructor Details

DistanceFeatureQueryBase

protected DistanceFeatureQueryBase(DistanceFeatureQueryBase.AbstractBuilder<TOrigin,TDistance,?> builder)

Method Details

origin

public final TOrigin origin()

Required - Date or point of origin used to calculate distances. If the field value is a date or date_nanos field, the origin value must be a date. Date Math, such as now-1h, is supported. If the field value is a geo_point field, the origin value must be a geopoint.

API name: origin

pivot

public final TDistance pivot()

Required - Distance from the origin at which relevance scores receive half of the boost value. If the field value is a date or date_nanos field, the pivot value must be a time unit, such as 1h or 10d. If the field value is a geo_point field, the pivot value must be a distance unit, such as 1km or 12m.

API name: pivot

field

public final String field()

Required - Name of the field used to calculate distances. This field must meet the following criteria: be a date, date_nanos or geo_point field; have an index mapping parameter value of true, which is the default; have an doc_values mapping parameter value of true, which is the default.

API name: field

serializeInternal

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

Overrides:

serializeInternal in class QueryBase

setupDistanceFeatureQueryBaseDeserializer

protected static <TOrigin,
TDistance,
BuilderT extends DistanceFeatureQueryBase.AbstractBuilder<TOrigin,
TDistance,
BuilderT>>
void setupDistanceFeatureQueryBaseDeserializer(ObjectDeserializer<BuilderT> op,
 JsonpDeserializer<TOrigin> tOriginDeserializer,
 JsonpDeserializer<TDistance> tDistanceDeserializer)