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

Class DistanceFeatureQuery.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.query_dsl.QueryBase.AbstractBuilder<DistanceFeatureQuery.Builder>
co.elastic.clients.elasticsearch._types.query_dsl.DistanceFeatureQuery.Builder
All Implemented Interfaces:
WithJson<DistanceFeatureQuery.Builder>, ObjectBuilder<DistanceFeatureQuery>
Enclosing class:
DistanceFeatureQuery
public static class DistanceFeatureQuery.Builder extends QueryBase.AbstractBuilder<DistanceFeatureQuery.Builder> implements ObjectBuilder<DistanceFeatureQuery>
Builder for DistanceFeatureQuery.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • origin

      public final DistanceFeatureQuery.Builder origin(JsonData value)
      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 DistanceFeatureQuery.Builder pivot(JsonData value)
      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 DistanceFeatureQuery.Builder field(String value)
      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

    • self

      protected DistanceFeatureQuery.Builder self()
      Specified by:
      self in class QueryBase.AbstractBuilder<DistanceFeatureQuery.Builder>

    • build

      public DistanceFeatureQuery build()
      Builds a DistanceFeatureQuery.
      Specified by:
      build in interface ObjectBuilder<DistanceFeatureQuery>
      Throws:
      NullPointerException - if some of the required fields are null.