Package org.springframework.data.redis.connection

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:

• Redis Documentation: GEORADIUSBYMEMBER

Method Summary

Modifier and Type	Method	Description
ReactiveGeoCommands.GeoRadiusByMemberCommand	forKey(ByteBuffer key)	Applies the Geo set key.
ReactiveGeoCommands.GeoRadiusByMemberCommand	from(ByteBuffer member)	Sets the member.
Optional<RedisGeoCommands.GeoRadiusCommandArgs>	getArgs()
Optional<Sort.Direction>	getDirection()
Distance	getDistance()
Set<RedisGeoCommands.GeoRadiusCommandArgs.Flag>	getFlags()
Optional<Long>	getLimit()
ByteBuffer	getMember()
Optional<ByteBuffer>	getStore()
Optional<ByteBuffer>	getStoreDist()
ReactiveGeoCommands.GeoRadiusByMemberCommand	limitTo(long limit)	Applies the limit.
ReactiveGeoCommands.GeoRadiusByMemberCommand	orderByDistanceAsc()	Applies ascending sort by distance.
ReactiveGeoCommands.GeoRadiusByMemberCommand	orderByDistanceDesc()	Applies descending sort by distance.
ReactiveGeoCommands.GeoRadiusByMemberCommand	sort(Sort.Direction direction)	Applies the distance sort Sort.Direction.
ReactiveGeoCommands.GeoRadiusByMemberCommand	storeAt(ByteBuffer key)	NOTE: STORE option is not compatible with WITHDIST, WITHHASH and WITHCOORDS options.
ReactiveGeoCommands.GeoRadiusByMemberCommand	storeDistAt(ByteBuffer key)	NOTE: STOREDIST option is not compatible with WITHDIST, WITHHASH and WITHCOORDS options.
ReactiveGeoCommands.GeoRadiusByMemberCommand	withArgs(RedisGeoCommands.GeoRadiusCommandArgs args)	Applies command RedisGeoCommands.GeoRadiusCommandArgs.
ReactiveGeoCommands.GeoRadiusByMemberCommand	withCoord()	Enables coordinate retrieval.
ReactiveGeoCommands.GeoRadiusByMemberCommand	withDist()	Enables distance retrieval.
ReactiveGeoCommands.GeoRadiusByMemberCommand	withFlag(RedisGeoCommands.GeoRadiusCommandArgs.Flag flag)	Applies command flags.
static ReactiveGeoCommands.GeoRadiusByMemberCommand	within(Distance distance)	Creates a new ReactiveGeoCommands.GeoRadiusByMemberCommand given a Distance.
static ReactiveGeoCommands.GeoRadiusByMemberCommand	withinFeet(double distance)	Creates a new ReactiveGeoCommands.GeoRadiusByMemberCommand given a distance in RedisGeoCommands.DistanceUnit.FEET.
static ReactiveGeoCommands.GeoRadiusByMemberCommand	withinKiometers(double distance)	Creates a new ReactiveGeoCommands.GeoRadiusByMemberCommand given a distance in RedisGeoCommands.DistanceUnit.KILOMETERS.
static ReactiveGeoCommands.GeoRadiusByMemberCommand	withinMeters(double distance)	Creates a new ReactiveGeoCommands.GeoRadiusByMemberCommand given a distance in RedisGeoCommands.DistanceUnit.METERS.
static ReactiveGeoCommands.GeoRadiusByMemberCommand	withinMiles(double distance)	Creates a new ReactiveGeoCommands.GeoRadiusByMemberCommand given a distance in RedisGeoCommands.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(Distance distance)

Creates a new ReactiveGeoCommands.GeoRadiusByMemberCommand given a Distance.

Parameters:

distance - must not be null.

Returns:

a new ReactiveGeoCommands.GeoRadiusByMemberCommand for a Distance.

withinMeters

public static ReactiveGeoCommands.GeoRadiusByMemberCommand withinMeters(double distance)

Creates a new ReactiveGeoCommands.GeoRadiusByMemberCommand given a distance in RedisGeoCommands.DistanceUnit.METERS.

Parameters:

distance - must not be null.

Returns:

a new ReactiveGeoCommands.GeoRadiusByMemberCommand for a distance in RedisGeoCommands.DistanceUnit.METERS.

withinKiometers

public static ReactiveGeoCommands.GeoRadiusByMemberCommand withinKiometers(double distance)

Creates a new ReactiveGeoCommands.GeoRadiusByMemberCommand given a distance in RedisGeoCommands.DistanceUnit.KILOMETERS.

Parameters:

distance - must not be null.

Returns:

a new ReactiveGeoCommands.GeoRadiusByMemberCommand for a distance in RedisGeoCommands.DistanceUnit.KILOMETERS.

withinMiles

public static ReactiveGeoCommands.GeoRadiusByMemberCommand withinMiles(double distance)

Creates a new ReactiveGeoCommands.GeoRadiusByMemberCommand given a distance in RedisGeoCommands.DistanceUnit.MILES.

Parameters:

distance - must not be null.

Returns:

a new ReactiveGeoCommands.GeoRadiusByMemberCommand for a distance in RedisGeoCommands.DistanceUnit.MILES.

withinFeet

public static ReactiveGeoCommands.GeoRadiusByMemberCommand withinFeet(double distance)

Creates a new ReactiveGeoCommands.GeoRadiusByMemberCommand given a distance in RedisGeoCommands.DistanceUnit.FEET.

Parameters:

distance - must not be null.

Returns:

a new ReactiveGeoCommands.GeoRadiusByMemberCommand for a distance in RedisGeoCommands.DistanceUnit.FEET.

from

public ReactiveGeoCommands.GeoRadiusByMemberCommand from(ByteBuffer member)

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 command flags. 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

public ReactiveGeoCommands.GeoRadiusByMemberCommand withCoord()

Enables coordinate retrieval. Constructs a new command instance with all previously configured properties.

Returns:

a new ReactiveGeoCommands.GeoRadiusByMemberCommand with RedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHCOORD applied.

withDist

public ReactiveGeoCommands.GeoRadiusByMemberCommand withDist()

Enables distance retrieval. Constructs a new command instance with all previously configured properties.

Returns:

a new ReactiveGeoCommands.GeoRadiusByMemberCommand with RedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHDIST applied.

withArgs

public ReactiveGeoCommands.GeoRadiusByMemberCommand withArgs(RedisGeoCommands.GeoRadiusCommandArgs args)

Applies command RedisGeoCommands.GeoRadiusCommandArgs. Constructs a new command instance with all previously configured properties.

Parameters:

args - must not be null.

Returns:

a new ReactiveGeoCommands.GeoRadiusByMemberCommand with RedisGeoCommands.GeoRadiusCommandArgs applied.

limitTo

public ReactiveGeoCommands.GeoRadiusByMemberCommand limitTo(long limit)

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(Sort.Direction direction)

Applies the distance sort Sort.Direction. Constructs a new command instance with all previously configured properties.

Parameters:

direction - must not be null.

Returns:

a new ReactiveGeoCommands.GeoRadiusByMemberCommand with sort Sort.Direction applied.

orderByDistanceAsc

public ReactiveGeoCommands.GeoRadiusByMemberCommand orderByDistanceAsc()

Applies ascending sort by distance. Constructs a new command instance with all previously configured properties.

Returns:

a new ReactiveGeoCommands.GeoRadiusByMemberCommand with sort Sort.Direction.ASC applied.

orderByDistanceDesc

public ReactiveGeoCommands.GeoRadiusByMemberCommand orderByDistanceDesc()

Applies descending sort by distance. Constructs a new command instance with all previously configured properties.

Returns:

a new ReactiveGeoCommands.GeoRadiusByMemberCommand with sort Sort.Direction.DESC applied.

forKey

public ReactiveGeoCommands.GeoRadiusByMemberCommand forKey(ByteBuffer key)

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

public ReactiveGeoCommands.GeoRadiusByMemberCommand storeAt(ByteBuffer key)

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

public ReactiveGeoCommands.GeoRadiusByMemberCommand storeDistAt(ByteBuffer key)

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

public Optional<Sort.Direction> getDirection()

Returns:

never null.

getDistance

public Distance getDistance()

Returns:

never null.

getFlags

public Set<RedisGeoCommands.GeoRadiusCommandArgs.Flag> getFlags()

Returns:

never null.

getLimit

public Optional<Long> getLimit()

Returns:

never null.

getMember

@Nullable
public ByteBuffer getMember()

Returns:

can be null.

getStore

public Optional<ByteBuffer> getStore()

Returns:

never null.

getStoreDist

public Optional<ByteBuffer> getStoreDist()

Returns:

never null.

getArgs

public Optional<RedisGeoCommands.GeoRadiusCommandArgs> getArgs()

Returns:

never null.