Package org.opensearch.client.opensearch._types

Class GeoLocation

java.lang.Object

org.opensearch.client.opensearch._types.GeoLocation

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, TaggedUnion<GeoLocation.Kind,Object>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class GeoLocation
extends Object
implements TaggedUnion<GeoLocation.Kind,Object>, PlainJsonSerializable

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.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final GeoLocation.Kind	_kind()	Get the of the kind of variant held by this object.
static GeoLocation.Builder	builder()
List<Double>	coords()	Get the coords variant value.
boolean	equals(Object o)
GeoHashLocation	geohash()	Get the geohash variant value.
int	hashCode()
boolean	isCoords()	Is this variant instance of kind coords?
boolean	isGeohash()	Is this variant instance of kind geohash?
boolean	isLatlon()	Is this variant instance of kind latlon?
boolean	isText()	Is this variant instance of kind text?
LatLonGeoLocation	latlon()	Get the latlon variant value.
static GeoLocation	of(Function<GeoLocation.Builder,ObjectBuilder<GeoLocation>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
String	text()	Get the text variant value.
GeoLocation.Builder	toBuilder()

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<GeoLocation> _DESERIALIZER

Method Details

_kind

public final GeoLocation.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

_kind in interface TaggedUnion<GeoLocation.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<GeoLocation.Kind,Object>

of

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

isCoords

public boolean isCoords()

Is this variant instance of kind coords?

coords

public List<Double> coords()

Get the coords variant value.

Throws:

IllegalStateException - if the current variant is not the coords kind.

isGeohash

public boolean isGeohash()

Is this variant instance of kind geohash?

geohash

public GeoHashLocation geohash()

Get the geohash variant value.

Throws:

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

isLatlon

public boolean isLatlon()

Is this variant instance of kind latlon?

latlon

public LatLonGeoLocation latlon()

Get the latlon variant value.

Throws:

IllegalStateException - if the current variant is not the latlon kind.

isText

public boolean isText()

Is this variant instance of kind text?

text

public String text()

Get the text variant value.

Throws:

IllegalStateException - if the current variant is not the text kind.

serialize

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

Specified by:

serialize in interface JsonpSerializable

toBuilder

@Nonnull
public GeoLocation.Builder toBuilder()

builder

@Nonnull
public static GeoLocation.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object