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

Class GeoDistanceQuery

java.lang.Object

org.opensearch.client.opensearch._types.query_dsl.QueryBase

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, QueryVariant, ToCopyableBuilder<GeoDistanceQuery.Builder,GeoDistanceQuery>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class GeoDistanceQuery
extends QueryBase
implements QueryVariant, ToCopyableBuilder<GeoDistanceQuery.Builder,GeoDistanceQuery>

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase

QueryBase.AbstractBuilder<BuilderT extends QueryBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<GeoDistanceQuery>	_DESERIALIZER	Json deserializer for GeoDistanceQuery

Method Summary

Modifier and Type	Method	Description
Query.Kind	_queryKind()	Query variant kind.
static GeoDistanceQuery.Builder	builder()
final String	distance()	Required - API name: distance
final GeoDistanceType	distanceType()	API name: distance_type
boolean	equals(Object o)
final String	field()	Required -
int	hashCode()
final Boolean	ignoreUnmapped()	API name: ignore_unmapped
final GeoLocation	location()	Required -
static GeoDistanceQuery	of(Function<GeoDistanceQuery.Builder,ObjectBuilder<GeoDistanceQuery>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupGeoDistanceQueryDeserializer(ObjectDeserializer<GeoDistanceQuery.Builder> op)
GeoDistanceQuery.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final GeoValidationMethod	validationMethod()	API name: validation_method

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

boost, queryName, serialize, setupQueryBaseDeserializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.opensearch._types.query_dsl.QueryVariant

toQuery

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<GeoDistanceQuery> _DESERIALIZER

Json deserializer for GeoDistanceQuery

Method Details

of

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

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

distance

@Nonnull
public final String distance()

Required - API name: distance

distanceType

@Nullable
public final GeoDistanceType distanceType()

API name: distance_type

field

@Nonnull
public final String field()

Required -

ignoreUnmapped

@Nullable
public final Boolean ignoreUnmapped()

API name: ignore_unmapped

location

@Nonnull
public final GeoLocation location()

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

@Nullable
public final GeoValidationMethod validationMethod()

API name: validation_method

serializeInternal

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

Overrides:

serializeInternal in class QueryBase

toBuilder

@Nonnull
public GeoDistanceQuery.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GeoDistanceQuery.Builder,GeoDistanceQuery>

Returns:

a new builder instance.

builder

@Nonnull
public static GeoDistanceQuery.Builder builder()

setupGeoDistanceQueryDeserializer

protected static void setupGeoDistanceQueryDeserializer(ObjectDeserializer<GeoDistanceQuery.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class QueryBase

equals

public boolean equals(Object o)

Overrides:

equals in class QueryBase