Package org.opensearch.client.opensearch._types

Class GeoBounds

java.lang.Object

org.opensearch.client.opensearch._types.GeoBounds

All Implemented Interfaces:

JsonpSerializable, TaggedUnion<GeoBounds.Kind,java.lang.Object>

@JsonpDeserializable
public class GeoBounds
extends java.lang.Object
implements TaggedUnion<GeoBounds.Kind,java.lang.Object>, JsonpSerializable

A geo bounding box. It can be represented in various ways:

• as 4 top/bottom/left/right coordinates
• as 2 top_left / bottom_right points
• as 2 top_right / bottom_left points
• as a WKT bounding box

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeoBounds.Builder
static class	GeoBounds.Kind

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<GeoBounds>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
java.lang.Object	_get()
GeoBounds.Kind	_kind()	Get the of the kind of variant held by this object.
CoordsGeoBounds	coords()	Get the coords variant value.
boolean	isCoords()	Is this variant instance of kind coords?
boolean	isTlbr()	Is this variant instance of kind tlbr?
boolean	isTrbl()	Is this variant instance of kind trbl?
boolean	isWkt()	Is this variant instance of kind wkt?
static GeoBounds	of(java.util.function.Function<GeoBounds.Builder,ObjectBuilder<GeoBounds>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
TopLeftBottomRightGeoBounds	tlbr()	Get the tlbr variant value.
TopRightBottomLeftGeoBounds	trbl()	Get the trbl variant value.
WktGeoBounds	wkt()	Get the wkt variant value.

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<GeoBounds> _DESERIALIZER

Method Detail

_kind

public final GeoBounds.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

_kind in interface TaggedUnion<GeoBounds.Kind,java.lang.Object>

Returns:

the variant kind

_get

public final java.lang.Object _get()

Specified by:

_get in interface TaggedUnion<GeoBounds.Kind,java.lang.Object>

of

public static GeoBounds of(java.util.function.Function<GeoBounds.Builder,ObjectBuilder<GeoBounds>> fn)

isCoords

public boolean isCoords()

Is this variant instance of kind coords?

coords

public CoordsGeoBounds coords()

Get the coords variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the coords kind.

isTlbr

public boolean isTlbr()

Is this variant instance of kind tlbr?

tlbr

public TopLeftBottomRightGeoBounds tlbr()

Get the tlbr variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the tlbr kind.

isTrbl

public boolean isTrbl()

Is this variant instance of kind trbl?

trbl

public TopRightBottomLeftGeoBounds trbl()

Get the trbl variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the trbl kind.

isWkt

public boolean isWkt()

Is this variant instance of kind wkt?

wkt

public WktGeoBounds wkt()

Get the wkt variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the wkt kind.

serialize

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

Specified by:

serialize in interface JsonpSerializable