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

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 Classes

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

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<GeoBoundingBoxQuery>	_DESERIALIZER	Json deserializer for GeoBoundingBoxQuery

Method Summary

Modifier and Type	Method	Description
Query.Kind	_queryKind()	Query variant kind.
final GeoBounds	boundingBox()	Required -
static GeoBoundingBoxQuery.Builder	builder()
boolean	equals(Object o)
final String	field()	Required -
int	hashCode()
final Boolean	ignoreUnmapped()	API name: ignore_unmapped
static GeoBoundingBoxQuery	of(Function<GeoBoundingBoxQuery.Builder,ObjectBuilder<GeoBoundingBoxQuery>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupGeoBoundingBoxQueryDeserializer(ObjectDeserializer<GeoBoundingBoxQuery.Builder> op)
GeoBoundingBoxQuery.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final GeoExecution	type()	API name: type
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<GeoBoundingBoxQuery> _DESERIALIZER

Json deserializer for GeoBoundingBoxQuery

Method Details

of

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

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

boundingBox

@Nonnull
public final GeoBounds 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

@Nonnull
public final String field()

Required -

ignoreUnmapped

@Nullable
public final Boolean ignoreUnmapped()

API name: ignore_unmapped

type

@Nullable
public final GeoExecution type()

API name: type

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 GeoBoundingBoxQuery.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<GeoBoundingBoxQuery.Builder,GeoBoundingBoxQuery>

Returns:

a new builder instance.

builder

@Nonnull
public static GeoBoundingBoxQuery.Builder builder()

setupGeoBoundingBoxQueryDeserializer

protected static void setupGeoBoundingBoxQueryDeserializer(ObjectDeserializer<GeoBoundingBoxQuery.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class QueryBase

equals

public boolean equals(Object o)

Overrides:

equals in class QueryBase