Package org.opensearch.client.opensearch._types

Class GeoDistanceSort

java.lang.Object

org.opensearch.client.opensearch._types.GeoDistanceSort

All Implemented Interfaces:

JsonpSerializable, SortOptionsVariant

@JsonpDeserializable
public class GeoDistanceSort
extends java.lang.Object
implements SortOptionsVariant, JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeoDistanceSort.Builder	Builder for GeoDistanceSort.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<GeoDistanceSort>	_DESERIALIZER	Json deserializer for GeoDistanceSort

Method Summary

Modifier and Type	Method	Description
SortOptions.Kind	_sortOptionsKind()	SortOptions variant kind.
GeoDistanceType	distanceType()	API name: distance_type
java.lang.String	field()	Required -
java.lang.Boolean	ignoreUnmapped()	API name: ignore_unmapped
java.util.List<GeoLocation>	location()	Required -
SortMode	mode()	API name: mode
static GeoDistanceSort	of(java.util.function.Function<GeoDistanceSort.Builder,ObjectBuilder<GeoDistanceSort>> fn)
SortOrder	order()	API name: order
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupGeoDistanceSortDeserializer(ObjectDeserializer<GeoDistanceSort.Builder> op)
DistanceUnit	unit()	API name: unit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.opensearch._types.SortOptionsVariant

_toSortOptions

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<GeoDistanceSort> _DESERIALIZER

Json deserializer for GeoDistanceSort

Method Detail

of

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

_sortOptionsKind

public SortOptions.Kind _sortOptionsKind()

SortOptions variant kind.

Specified by:

_sortOptionsKind in interface SortOptionsVariant

field

public final java.lang.String field()

Required -

location

public final java.util.List<GeoLocation> location()

Required -

mode

@Nullable
public final SortMode mode()

API name: mode

distanceType

@Nullable
public final GeoDistanceType distanceType()

API name: distance_type

ignoreUnmapped

@Nullable
public final java.lang.Boolean ignoreUnmapped()

API name: ignore_unmapped

order

@Nullable
public final SortOrder order()

API name: order

unit

@Nullable
public final DistanceUnit unit()

API name: unit

serialize

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

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

setupGeoDistanceSortDeserializer

protected static void setupGeoDistanceSortDeserializer(ObjectDeserializer<GeoDistanceSort.Builder> op)