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

Class DistanceFeatureQuery

java.lang.Object

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

co.elastic.clients.elasticsearch._types.query_dsl.DistanceFeatureQuery

All Implemented Interfaces:

QueryVariant, JsonpSerializable

@JsonpDeserializable
public class DistanceFeatureQuery
extends QueryBase
implements QueryVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<DistanceFeatureQuery>	_DESERIALIZER	Json deserializer for DistanceFeatureQuery

Method Summary

Modifier and Type	Method	Description
Query.Kind	_queryKind()	Query variant kind.
final String	field()	Required - Name of the field used to calculate distances.
static DistanceFeatureQuery	of(Function<DistanceFeatureQuery.Builder,ObjectBuilder<DistanceFeatureQuery>> fn)
final JsonData	origin()	Required - Date or point of origin used to calculate distances.
final JsonData	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 void	setupDistanceFeatureQueryDeserializer(ObjectDeserializer<DistanceFeatureQuery.Builder> op)

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<DistanceFeatureQuery> _DESERIALIZER

Json deserializer for DistanceFeatureQuery

Method Details

of

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

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

origin

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

setupDistanceFeatureQueryDeserializer

protected static void setupDistanceFeatureQueryDeserializer(ObjectDeserializer<DistanceFeatureQuery.Builder> op)