Class GeoBoundingBoxQuery
java.lang.Object
org.opensearch.client.opensearch._types.query_dsl.QueryBase
org.opensearch.client.opensearch._types.query_dsl.GeoBoundingBoxQuery
- All Implemented Interfaces:
JsonpSerializable,PlainJsonSerializable,QueryVariant,ToCopyableBuilder<GeoBoundingBoxQuery.Builder,GeoBoundingBoxQuery>
@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class GeoBoundingBoxQuery
extends QueryBase
implements QueryVariant, ToCopyableBuilder<GeoBoundingBoxQuery.Builder,GeoBoundingBoxQuery>
-
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<GeoBoundingBoxQuery> Json deserializer forGeoBoundingBoxQuery -
Method Summary
Modifier and TypeMethodDescriptionQueryvariant kind.final GeoBoundsRequired -static GeoBoundingBoxQuery.Builderbuilder()booleanfinal Stringfield()Required -inthashCode()final BooleanAPI name:ignore_unmappedstatic GeoBoundingBoxQueryprotected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.final GeoExecutiontype()API name:typefinal 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 forGeoBoundingBoxQuery
-
-
Method Details
-
of
public static GeoBoundingBoxQuery of(Function<GeoBoundingBoxQuery.Builder, ObjectBuilder<GeoBoundingBoxQuery>> fn) -
_queryKind
Queryvariant kind.- Specified by:
_queryKindin interfaceQueryVariant
-
boundingBox
Required -A geo-bounding box. It can be represented in the following ways:
- As 4 top/bottom/left/right coordinates.
- As 2 top_left/bottom_right points.
- As 2 top_right/bottom_left points.
- As a Well Known Text (WKT) bounding box.
-
field
Required - -
ignoreUnmapped
API name:ignore_unmapped -
type
API name:type -
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<GeoBoundingBoxQuery.Builder,GeoBoundingBoxQuery> - Returns:
- a new builder instance.
-
builder
-
setupGeoBoundingBoxQueryDeserializer
protected static void setupGeoBoundingBoxQueryDeserializer(ObjectDeserializer<GeoBoundingBoxQuery.Builder> op) -
hashCode
public int hashCode() -
equals
-