Package glide.api.models.commands.geospatial

Class GeoSearchOptions

java.lang.Object

glide.api.models.commands.geospatial.GeoSearchOptions

public final class GeoSearchOptions
extends java.lang.Object

Optional arguments for GeospatialIndicesBaseCommands.geosearch(String, GeoSearchOrigin.SearchOrigin, GeoSearchShape, GeoSearchOptions) command, options include:

• WITHDIST: Also return the distance of the returned items from the specified center point. The distance is returned in the same unit as specified for the searchBy argument.
• WITHCOORD: Also return the coordinate of the returned items.
• WITHHASH: Also return the geohash of the returned items.

See Also:

valkey.io

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeoSearchOptions.GeoSearchOptionsBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	WITHCOORD_VALKEY_API	Valkey API keyword used to perform geosearch with coordinates.
static java.lang.String	WITHDIST_VALKEY_API	Valkey API keyword used to perform geosearch with distance.
static java.lang.String	WITHHASH_VALKEY_API	Valkey API keyword used to perform geosearch with hash value.

Method Summary

Modifier and Type	Method	Description
static GeoSearchOptions.GeoSearchOptionsBuilder	builder()
java.lang.String[]	toArgs()	Converts GeoSearchOptions into a String[].

Methods inherited from class java.lang.Object

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

Field Detail

WITHCOORD_VALKEY_API

public static final java.lang.String WITHCOORD_VALKEY_API

Valkey API keyword used to perform geosearch with coordinates.

See Also:

Constant Field Values

WITHDIST_VALKEY_API

public static final java.lang.String WITHDIST_VALKEY_API

Valkey API keyword used to perform geosearch with distance.

See Also:

Constant Field Values

WITHHASH_VALKEY_API

public static final java.lang.String WITHHASH_VALKEY_API

Valkey API keyword used to perform geosearch with hash value.

See Also:

Constant Field Values

Method Detail

toArgs

public java.lang.String[] toArgs()

Converts GeoSearchOptions into a String[].

Returns:

String[]

builder

public static GeoSearchOptions.GeoSearchOptionsBuilder builder()