Package org.opensearch.client.opensearch._types.query_dsl

Class GeoDistanceQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder<GeoDistanceQuery.Builder>

org.opensearch.client.opensearch._types.query_dsl.GeoDistanceQuery.Builder

All Implemented Interfaces:

CopyableBuilder<GeoDistanceQuery.Builder,GeoDistanceQuery>, MutableBuilder<GeoDistanceQuery.Builder,GeoDistanceQuery>, ObjectBuilder<GeoDistanceQuery>

Enclosing class:

GeoDistanceQuery

public static class GeoDistanceQuery.Builder
extends QueryBase.AbstractBuilder<GeoDistanceQuery.Builder>
implements CopyableBuilder<GeoDistanceQuery.Builder,GeoDistanceQuery>

Builder for GeoDistanceQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GeoDistanceQuery	build()	Builds a GeoDistanceQuery.
GeoDistanceQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GeoDistanceQuery.Builder	distance(String value)	Required - API name: distance
final GeoDistanceQuery.Builder	distanceType(GeoDistanceType value)	API name: distance_type
final GeoDistanceQuery.Builder	field(String value)	Required -
final GeoDistanceQuery.Builder	ignoreUnmapped(Boolean value)	API name: ignore_unmapped
final GeoDistanceQuery.Builder	location(Function<GeoLocation.Builder,ObjectBuilder<GeoLocation>> fn)	Required -
final GeoDistanceQuery.Builder	location(GeoLocation value)	Required -
protected GeoDistanceQuery.Builder	self()
final GeoDistanceQuery.Builder	validationMethod(GeoValidationMethod value)	API name: validation_method

Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder

boost, queryName

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public GeoDistanceQuery.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<GeoDistanceQuery.Builder,GeoDistanceQuery>

Returns:

a new builder instance.

self

@Nonnull
protected GeoDistanceQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<GeoDistanceQuery.Builder>

distance

@Nonnull
public final GeoDistanceQuery.Builder distance(String value)

Required - API name: distance

distanceType

@Nonnull
public final GeoDistanceQuery.Builder distanceType(@Nullable
 GeoDistanceType value)

API name: distance_type

field

@Nonnull
public final GeoDistanceQuery.Builder field(String value)

Required -

ignoreUnmapped

@Nonnull
public final GeoDistanceQuery.Builder ignoreUnmapped(@Nullable
 Boolean value)

API name: ignore_unmapped

location

@Nonnull
public final GeoDistanceQuery.Builder location(GeoLocation value)

Required -

A latitude/longitude as a two-dimensional point. It can be represented in the following ways:

• As a {lat, long} object.
• As a geohash value.
• As a [lon, lat] array.
• As a string in <lat>, <lon> or WKT point format.

location

@Nonnull
public final GeoDistanceQuery.Builder location(Function<GeoLocation.Builder,ObjectBuilder<GeoLocation>> fn)

Required -

A latitude/longitude as a two-dimensional point. It can be represented in the following ways:

• As a {lat, long} object.
• As a geohash value.
• As a [lon, lat] array.
• As a string in <lat>, <lon> or WKT point format.

validationMethod

@Nonnull
public final GeoDistanceQuery.Builder validationMethod(@Nullable
 GeoValidationMethod value)

API name: validation_method

build

@Nonnull
public GeoDistanceQuery build()

Builds a GeoDistanceQuery.

Specified by:

build in interface ObjectBuilder<GeoDistanceQuery>

Throws:

NullPointerException - if some of the required fields are null.