Package org.opensearch.client.opensearch._types

Class XyLocation

java.lang.Object

org.opensearch.client.opensearch._types.XyLocation

All Implemented Interfaces:

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

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

A two-dimensional Cartesian point specified by x and y coordinates. It can be represented in the following ways:

• As an {x, y} object.
• As an [x, y] array.
• As a string in "x, y" or WKT point format.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final XyLocation.Kind	_kind()	Get the of the kind of variant held by this object.
static XyLocation.Builder	builder()
XyCartesianCoordinates	cartesian()	Get the cartesian variant value.
List<Double>	coords()	Get the coords variant value.
boolean	equals(Object o)
int	hashCode()
boolean	isCartesian()	Is this variant instance of kind cartesian?
boolean	isCoords()	Is this variant instance of kind coords?
boolean	isText()	Is this variant instance of kind text?
static XyLocation	of(Function<XyLocation.Builder,ObjectBuilder<XyLocation>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
String	text()	Get the text variant value.
XyLocation.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<XyLocation> _DESERIALIZER

Method Details

_kind

public final XyLocation.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

_kind in interface TaggedUnion<XyLocation.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<XyLocation.Kind,Object>

of

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

isCartesian

public boolean isCartesian()

Is this variant instance of kind cartesian?

cartesian

public XyCartesianCoordinates cartesian()

Get the cartesian variant value.

Throws:

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

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.

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 XyLocation.Builder toBuilder()

builder

@Nonnull
public static XyLocation.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object