Package org.opensearch.client.opensearch._types

Class GeoBounds

java.lang.Object

org.opensearch.client.opensearch._types.GeoBounds

All Implemented Interfaces:

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

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

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.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final GeoBounds.Kind	_kind()	Get the of the kind of variant held by this object.
static GeoBounds.Builder	builder()
CoordsGeoBounds	coords()	Get the coords variant value.
boolean	equals(Object o)
int	hashCode()
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(Function<GeoBounds.Builder,ObjectBuilder<GeoBounds>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
TopLeftBottomRightGeoBounds	tlbr()	Get the tlbr variant value.
GeoBounds.Builder	toBuilder()
TopRightBottomLeftGeoBounds	trbl()	Get the trbl variant value.
WktGeoBounds	wkt()	Get the wkt variant value.

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<GeoBounds> _DESERIALIZER

Method Details

_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,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<GeoBounds.Kind,Object>

of

public static GeoBounds of(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:

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

isTlbr

public boolean isTlbr()

Is this variant instance of kind tlbr?

tlbr

public TopLeftBottomRightGeoBounds tlbr()

Get the tlbr variant value.

Throws:

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

isTrbl

public boolean isTrbl()

Is this variant instance of kind trbl?

trbl

public TopRightBottomLeftGeoBounds trbl()

Get the trbl variant value.

Throws:

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

isWkt

public boolean isWkt()

Is this variant instance of kind wkt?

wkt

public WktGeoBounds wkt()

Get the wkt variant value.

Throws:

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

serialize

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

Specified by:

serialize in interface JsonpSerializable

toBuilder

@Nonnull
public GeoBounds.Builder toBuilder()

builder

@Nonnull
public static GeoBounds.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object