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 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 final JsonpDeserializer<GeoDistanceSort>	_DESERIALIZER	Json deserializer for GeoDistanceSort

Method Summary

Modifier and Type	Method	Description
SortOptions.Kind	_sortOptionsKind()	SortOptions variant kind.
final GeoDistanceType	distanceType()	API name: distance_type
final String	field()	Required -
final Boolean	ignoreUnmapped()	API name: ignore_unmapped
final List<GeoLocation>	location()	Required -
final SortMode	mode()	API name: mode
final NestedSortValue	nested()	API name: nested
static GeoDistanceSort	of(Function<GeoDistanceSort.Builder,ObjectBuilder<GeoDistanceSort>> fn)
final 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)
final DistanceUnit	unit()	API name: unit
final GeoValidationMethod	validationMethod()	API name: validation_method

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 Details

_DESERIALIZER

public static final JsonpDeserializer<GeoDistanceSort> _DESERIALIZER

Json deserializer for GeoDistanceSort

Method Details

of

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

_sortOptionsKind

public SortOptions.Kind _sortOptionsKind()

SortOptions variant kind.

Specified by:

_sortOptionsKind in interface SortOptionsVariant

field

public final String field()

Required -

location

public final 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 Boolean ignoreUnmapped()

API name: ignore_unmapped

order

@Nullable
public final SortOrder order()

API name: order

unit

@Nullable
public final DistanceUnit unit()

API name: unit

validationMethod

@Nullable
public final GeoValidationMethod validationMethod()

API name: validation_method

nested

@Nullable
public final NestedSortValue nested()

API name: nested

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)