Class ReactiveGeoCommands.GeoRadiusByMemberCommand
java.lang.Object
org.springframework.data.redis.connection.ReactiveRedisConnection.KeyCommand
org.springframework.data.redis.connection.ReactiveGeoCommands.GeoRadiusByMemberCommand
- All Implemented Interfaces:
ReactiveRedisConnection.Command
- Enclosing interface:
- ReactiveGeoCommands
public static class ReactiveGeoCommands.GeoRadiusByMemberCommand
extends ReactiveRedisConnection.KeyCommand
GEORADIUSBYMEMBER
command parameters.- Author:
- Christoph Strobl
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionforKey
(ByteBuffer key) Applies the Geo set key.from
(ByteBuffer member) Sets the member.getArgs()
Optional<org.springframework.data.domain.Sort.Direction>
org.springframework.data.geo.Distance
getFlags()
getLimit()
getStore()
limitTo
(long limit) Applies the limit.Applies ascending sort by distance.Applies descending sort by distance.sort
(org.springframework.data.domain.Sort.Direction direction) Applies the distance sortSort.Direction
.storeAt
(ByteBuffer key) NOTE: STORE option is not compatible with WITHDIST, WITHHASH and WITHCOORDS options.storeDistAt
(ByteBuffer key) NOTE: STOREDIST option is not compatible with WITHDIST, WITHHASH and WITHCOORDS options.Applies commandRedisGeoCommands.GeoRadiusCommandArgs
.Enables coordinate retrieval.withDist()
Enables distance retrieval.Applies commandflags
.within
(org.springframework.data.geo.Distance distance) Creates a newReactiveGeoCommands.GeoRadiusByMemberCommand
given aDistance
.withinFeet
(double distance) Creates a newReactiveGeoCommands.GeoRadiusByMemberCommand
given a distance inRedisGeoCommands.DistanceUnit.FEET
.withinKiometers
(double distance) Creates a newReactiveGeoCommands.GeoRadiusByMemberCommand
given a distance inRedisGeoCommands.DistanceUnit.KILOMETERS
.withinMeters
(double distance) Creates a newReactiveGeoCommands.GeoRadiusByMemberCommand
given a distance inRedisGeoCommands.DistanceUnit.METERS
.withinMiles
(double distance) Creates a newReactiveGeoCommands.GeoRadiusByMemberCommand
given a distance inRedisGeoCommands.DistanceUnit.MILES
.Methods inherited from class org.springframework.data.redis.connection.ReactiveRedisConnection.KeyCommand
getKey
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.data.redis.connection.ReactiveRedisConnection.Command
getName
-
Method Details
-
within
public static ReactiveGeoCommands.GeoRadiusByMemberCommand within(org.springframework.data.geo.Distance distance) Creates a newReactiveGeoCommands.GeoRadiusByMemberCommand
given aDistance
.- Parameters:
distance
- must not be null.- Returns:
- a new
ReactiveGeoCommands.GeoRadiusByMemberCommand
for aDistance
.
-
withinMeters
Creates a newReactiveGeoCommands.GeoRadiusByMemberCommand
given a distance inRedisGeoCommands.DistanceUnit.METERS
.- Parameters:
distance
- must not be null.- Returns:
- a new
ReactiveGeoCommands.GeoRadiusByMemberCommand
for a distance inRedisGeoCommands.DistanceUnit.METERS
.
-
withinKiometers
Creates a newReactiveGeoCommands.GeoRadiusByMemberCommand
given a distance inRedisGeoCommands.DistanceUnit.KILOMETERS
.- Parameters:
distance
- must not be null.- Returns:
- a new
ReactiveGeoCommands.GeoRadiusByMemberCommand
for a distance inRedisGeoCommands.DistanceUnit.KILOMETERS
.
-
withinMiles
Creates a newReactiveGeoCommands.GeoRadiusByMemberCommand
given a distance inRedisGeoCommands.DistanceUnit.MILES
.- Parameters:
distance
- must not be null.- Returns:
- a new
ReactiveGeoCommands.GeoRadiusByMemberCommand
for a distance inRedisGeoCommands.DistanceUnit.MILES
.
-
withinFeet
Creates a newReactiveGeoCommands.GeoRadiusByMemberCommand
given a distance inRedisGeoCommands.DistanceUnit.FEET
.- Parameters:
distance
- must not be null.- Returns:
- a new
ReactiveGeoCommands.GeoRadiusByMemberCommand
for a distance inRedisGeoCommands.DistanceUnit.FEET
.
-
from
Sets the member. Constructs a new command instance with all previously configured properties.- Parameters:
member
- must not be null.- Returns:
- a new
ReactiveGeoCommands.GeoRadiusByMemberCommand
with member applied.
-
withFlag
public ReactiveGeoCommands.GeoRadiusByMemberCommand withFlag(RedisGeoCommands.GeoRadiusCommandArgs.Flag flag) Applies commandflags
. Constructs a new command instance with all previously configured properties.- Parameters:
flag
- must not be null.- Returns:
- a new
ReactiveGeoCommands.GeoRadiusByMemberCommand
with key applied.
-
withCoord
Enables coordinate retrieval. Constructs a new command instance with all previously configured properties.- Returns:
- a new
ReactiveGeoCommands.GeoRadiusByMemberCommand
withRedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHCOORD
applied.
-
withDist
Enables distance retrieval. Constructs a new command instance with all previously configured properties.- Returns:
- a new
ReactiveGeoCommands.GeoRadiusByMemberCommand
withRedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHDIST
applied.
-
withArgs
public ReactiveGeoCommands.GeoRadiusByMemberCommand withArgs(RedisGeoCommands.GeoRadiusCommandArgs args) Applies commandRedisGeoCommands.GeoRadiusCommandArgs
. Constructs a new command instance with all previously configured properties.- Parameters:
args
- must not be null.- Returns:
- a new
ReactiveGeoCommands.GeoRadiusByMemberCommand
withRedisGeoCommands.GeoRadiusCommandArgs
applied.
-
limitTo
Applies the limit. Constructs a new command instance with all previously configured properties.- Parameters:
limit
-- Returns:
- a new
ReactiveGeoCommands.GeoRadiusByMemberCommand
with limit applied.
-
sort
public ReactiveGeoCommands.GeoRadiusByMemberCommand sort(org.springframework.data.domain.Sort.Direction direction) Applies the distance sortSort.Direction
. Constructs a new command instance with all previously configured properties.- Parameters:
direction
- must not be null.- Returns:
- a new
ReactiveGeoCommands.GeoRadiusByMemberCommand
with sortSort.Direction
applied.
-
orderByDistanceAsc
Applies ascending sort by distance. Constructs a new command instance with all previously configured properties.- Returns:
- a new
ReactiveGeoCommands.GeoRadiusByMemberCommand
with sortSort.Direction.ASC
applied.
-
orderByDistanceDesc
Applies descending sort by distance. Constructs a new command instance with all previously configured properties.- Returns:
- a new
ReactiveGeoCommands.GeoRadiusByMemberCommand
with sortSort.Direction.DESC
applied.
-
forKey
Applies the Geo set key. Constructs a new command instance with all previously configured properties.- Parameters:
key
- must not be null.- Returns:
- a new
ReactiveGeoCommands.GeoRadiusByMemberCommand
with key applied.
-
storeAt
NOTE: STORE option is not compatible with WITHDIST, WITHHASH and WITHCOORDS options.- Parameters:
key
- must not be null.- Returns:
- new instance of
ReactiveGeoCommands.GeoRadiusByMemberCommand
.
-
storeDistAt
NOTE: STOREDIST option is not compatible with WITHDIST, WITHHASH and WITHCOORDS options.- Parameters:
key
- must not be null.- Returns:
- new instance of
ReactiveGeoCommands.GeoRadiusByMemberCommand
.
-
getDirection
- Returns:
- never null.
-
getDistance
public org.springframework.data.geo.Distance getDistance()- Returns:
- never null.
-
getFlags
- Returns:
- never null.
-
getLimit
- Returns:
- never null.
-
getMember
- Returns:
- can be null.
-
getStore
- Returns:
- never null.
-
getStoreDist
- Returns:
- never null.
-
getArgs
- Returns:
- never null.
-