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 ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase
QueryBase.AbstractBuilder<BuilderT extends QueryBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<GeoDistanceQuery> Json deserializer forGeoDistanceQuery -
Method Summary
Modifier and TypeMethodDescriptionQueryvariant kind.static GeoDistanceQuery.Builderbuilder()final Stringdistance()Required - API name:distancefinal GeoDistanceTypeAPI name:distance_typebooleanfinal Stringfield()Required -inthashCode()final BooleanAPI name:ignore_unmappedfinal GeoLocationlocation()Required -static GeoDistanceQueryprotected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.final GeoValidationMethodAPI name:validation_methodMethods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase
boost, queryName, serialize, setupQueryBaseDeserializerMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.opensearch._types.query_dsl.QueryVariant
toQueryMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forGeoDistanceQuery
-
-
Method Details
-
of
public static GeoDistanceQuery of(Function<GeoDistanceQuery.Builder, ObjectBuilder<GeoDistanceQuery>> fn) -
_queryKind
Queryvariant kind.- Specified by:
_queryKindin interfaceQueryVariant
-
distance
Required - API name:distance -
distanceType
API name:distance_type -
field
Required - -
ignoreUnmapped
API name:ignore_unmapped -
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.
- As a
-
validationMethod
API name:validation_method -
serializeInternal
- Overrides:
serializeInternalin classQueryBase
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<GeoDistanceQuery.Builder,GeoDistanceQuery> - Returns:
- a new builder instance.
-
builder
-
setupGeoDistanceQueryDeserializer
protected static void setupGeoDistanceQueryDeserializer(ObjectDeserializer<GeoDistanceQuery.Builder> op) -
hashCode
public int hashCode() -
equals
-