Package io.quarkus.redis.datasource.geo
Class GeoRadiusArgs
- java.lang.Object
-
- io.quarkus.redis.datasource.geo.GeoRadiusArgs
-
- All Implemented Interfaces:
RedisCommandExtraArguments
public class GeoRadiusArgs extends Object implements RedisCommandExtraArguments
-
-
Constructor Summary
Constructors Constructor Description GeoRadiusArgs()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GeoRadiusArgs
any()
When ANY is provided the command will return as soon as enough matches are found, so the results may not be the ones closest to the specified point, but on the other hand, the effort invested by the server is significantly lower.GeoRadiusArgs
ascending()
UseASC
order (from small to large).GeoRadiusArgs
count(long count)
By default all the matching items are returned.GeoRadiusArgs
descending()
UseDESC
order (from large to small).boolean
hasCoordinates()
boolean
hasDistance()
boolean
hasHash()
List<String>
toArgs()
GeoRadiusArgs
withCoordinates()
Also return the longitude,latitude coordinates of the matching items.GeoRadiusArgs
withDistance()
Also return the distance of the returned items from the specified center.GeoRadiusArgs
withHash()
Also return the raw geohash-encoded sorted set score of the item, in the form of a 52 bit unsigned integer.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface io.quarkus.redis.datasource.RedisCommandExtraArguments
toArgs
-
-
-
-
Method Detail
-
ascending
public GeoRadiusArgs ascending()
UseASC
order (from small to large).- Returns:
- the current
GeoRadiusArgs
-
descending
public GeoRadiusArgs descending()
UseDESC
order (from large to small).- Returns:
- the current
GeoRadiusArgs
-
withDistance
public GeoRadiusArgs withDistance()
Also return the distance of the returned items from the specified center. The distance is returned in the same unit as the unit specified as the radius argument of the command.- Returns:
- the current
GeoRadiusArgs
-
withCoordinates
public GeoRadiusArgs withCoordinates()
Also return the longitude,latitude coordinates of the matching items.- Returns:
- the current
GeoRadiusArgs
-
withHash
public GeoRadiusArgs withHash()
Also return the raw geohash-encoded sorted set score of the item, in the form of a 52 bit unsigned integer. This is only useful for low level hacks or debugging and is otherwise of little interest for the general user.- Returns:
- the current
GeoRadiusArgs
-
count
public GeoRadiusArgs count(long count)
By default all the matching items are returned. It is possible to limit the results to the first N matching items by using theCOUNT <count>
option.- Parameters:
count
- the count value- Returns:
- the current
GeoRadiusArgs
-
any
public GeoRadiusArgs any()
When ANY is provided the command will return as soon as enough matches are found, so the results may not be the ones closest to the specified point, but on the other hand, the effort invested by the server is significantly lower.Using
ANY
requirescount
to be set.- Returns:
- the current
GeoRadiusArgs
-
toArgs
public List<String> toArgs()
- Specified by:
toArgs
in interfaceRedisCommandExtraArguments
- Returns:
- the list of arguments, encoded as a list of String.
-
hasDistance
public boolean hasDistance()
-
hasHash
public boolean hasHash()
-
hasCoordinates
public boolean hasCoordinates()
-
-