Package co.elastic.clients.elasticsearch._types.query_dsl

Class GeoGridQuery

java.lang.Object

co.elastic.clients.elasticsearch._types.query_dsl.QueryBase

co.elastic.clients.elasticsearch._types.query_dsl.GeoGridQuery

All Implemented Interfaces:

QueryVariant, JsonpSerializable, TaggedUnion<GeoGridQuery.Kind,Object>

@JsonpDeserializable
public class GeoGridQuery
extends QueryBase
implements TaggedUnion<GeoGridQuery.Kind,Object>, QueryVariant, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeoGridQuery.Builder
static enum	GeoGridQuery.Kind	GeoGridQuery variant kinds.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<GeoGridQuery>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final GeoGridQuery.Kind	_kind()	Get the of the kind of variant held by this object.
Query.Kind	_queryKind()	Query variant kind.
final String	field()	Required - The target field
String	geohash()	Get the geohash variant value.
String	geohex()	Get the geohex variant value.
String	geotile()	Get the geotile variant value.
boolean	isGeohash()	Is this variant instance of kind geohash?
boolean	isGeohex()	Is this variant instance of kind geohex?
boolean	isGeotile()	Is this variant instance of kind geotile?
static GeoGridQuery	of(Function<GeoGridQuery.Builder,ObjectBuilder<GeoGridQuery>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected static void	setupGeoGridQueryDeserializer(ObjectDeserializer<GeoGridQuery.Builder> op)
String	toString()

Methods inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase

boost, queryName, serializeInternal, setupQueryBaseDeserializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch._types.query_dsl.QueryVariant

_toQuery

Field Details

_DESERIALIZER

public static final JsonpDeserializer<GeoGridQuery> _DESERIALIZER

Method Details

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

_kind

public final GeoGridQuery.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<GeoGridQuery.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<GeoGridQuery.Kind,Object>

of

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

field

public final String field()

Required - The target field

isGeotile

public boolean isGeotile()

Is this variant instance of kind geotile?

geotile

public String geotile()

Get the geotile variant value.

Throws:

IllegalStateException - if the current variant is not of the geotile kind.

isGeohash

public boolean isGeohash()

Is this variant instance of kind geohash?

geohash

public String geohash()

Get the geohash variant value.

Throws:

IllegalStateException - if the current variant is not of the geohash kind.

isGeohex

public boolean isGeohex()

Is this variant instance of kind geohex?

geohex

public String geohex()

Get the geohex variant value.

Throws:

IllegalStateException - if the current variant is not of the geohex kind.

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Description copied from class: QueryBase

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

Overrides:

serialize in class QueryBase

toString

public String toString()

Overrides:

toString in class QueryBase

setupGeoGridQueryDeserializer

protected static void setupGeoGridQueryDeserializer(ObjectDeserializer<GeoGridQuery.Builder> op)