Class DistanceFeatureQueryDescriptor<T>

Inheritance
object
DescriptorBase<DistanceFeatureQueryDescriptor<T>, IDistanceFeatureQuery>
QueryDescriptorBase<DistanceFeatureQueryDescriptor<T>, IDistanceFeatureQuery>
FieldNameQueryDescriptorBase<DistanceFeatureQueryDescriptor<T>, IDistanceFeatureQuery, T>
DistanceFeatureQueryDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class DistanceFeatureQueryDescriptor<T> : FieldNameQueryDescriptorBase<DistanceFeatureQueryDescriptor<T>, IDistanceFeatureQuery, T>, IDescriptor, IDistanceFeatureQuery, IFieldNameQuery, IQuery where T : class
Type Parameters
Name Description
T

Properties

| Edit this page View Source

Conditionless

Whether the query is conditionless. A conditionless query is not serialized as part of the request sent to OpenSearch.

Declaration
protected override bool Conditionless { get; }
Property Value
Type Description
bool
Overrides

Methods

| Edit this page View Source

Origin(DateMath)

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.

Declaration
public DistanceFeatureQueryDescriptor<T> Origin(DateMath origin)
Parameters
Type Name Description
DateMath origin
Returns
Type Description
DistanceFeatureQueryDescriptor<T>
| Edit this page View Source

Origin(GeoCoordinate)

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.

Declaration
public DistanceFeatureQueryDescriptor<T> Origin(GeoCoordinate origin)
Parameters
Type Name Description
GeoCoordinate origin
Returns
Type Description
DistanceFeatureQueryDescriptor<T>
| Edit this page View Source

Pivot(Distance)

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.

Declaration
public DistanceFeatureQueryDescriptor<T> Pivot(Distance pivot)
Parameters
Type Name Description
Distance pivot
Returns
Type Description
DistanceFeatureQueryDescriptor<T>
| Edit this page View Source

Pivot(Time)

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.

Declaration
public DistanceFeatureQueryDescriptor<T> Pivot(Time pivot)
Parameters
Type Name Description
Time pivot
Returns
Type Description
DistanceFeatureQueryDescriptor<T>

Implements

Extension Methods