ReactiveGeoCommands.GeoRadiusCommand (Spring Data Redis 2.1.8.RELEASE API)

java.lang.Object
- org.springframework.data.redis.connection.ReactiveRedisConnection.KeyCommand
- - org.springframework.data.redis.connection.ReactiveGeoCommands.GeoRadiusCommand

All Implemented Interfaces:

ReactiveRedisConnection.Command

Enclosing interface:

ReactiveGeoCommands
```
public static class ReactiveGeoCommands.GeoRadiusCommand
extends ReactiveRedisConnection.KeyCommand
```
GEORADIUS command parameters.

Author:

Christoph Strobl

See Also:

Redis Documentation: GEORADIUS

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ReactiveGeoCommands.GeoRadiusCommand`	`forKey(ByteBuffer key)` Applies the Geo set key.
`ReactiveGeoCommands.GeoRadiusCommand`	`from(Point center)` Sets the center `Point`.
`Optional<RedisGeoCommands.GeoRadiusCommandArgs>`	`getArgs()`
`Optional<Sort.Direction>`	`getDirection()`
`Distance`	`getDistance()`
`Set<RedisGeoCommands.GeoRadiusCommandArgs.Flag>`	`getFlags()`
`Optional<Long>`	`getLimit()`
`Point`	`getPoint()`
`Optional<ByteBuffer>`	`getStore()`
`Optional<ByteBuffer>`	`getStoreDist()`
`ReactiveGeoCommands.GeoRadiusCommand`	`limitTo(long limit)` Applies the limit.
`ReactiveGeoCommands.GeoRadiusCommand`	`orderByDistanceAsc()` Applies ascending sort by distance.
`ReactiveGeoCommands.GeoRadiusCommand`	`orderByDistanceDesc()` Applies descending sort by distance.
`ReactiveGeoCommands.GeoRadiusCommand`	`sort(Sort.Direction direction)` Applies the distance sort `Sort.Direction`.
`ReactiveGeoCommands.GeoRadiusCommand`	`storeAt(ByteBuffer key)` NOTE: STORE option is not compatible with WITHDIST, WITHHASH and WITHCOORDS options.
`ReactiveGeoCommands.GeoRadiusCommand`	`storeDistAt(ByteBuffer key)` NOTE: STOREDIST option is not compatible with WITHDIST, WITHHASH and WITHCOORDS options.
`ReactiveGeoCommands.GeoRadiusCommand`	`withArgs(RedisGeoCommands.GeoRadiusCommandArgs args)` Applies command `RedisGeoCommands.GeoRadiusCommandArgs`.
`ReactiveGeoCommands.GeoRadiusCommand`	`withCoord()` Enables coordinate retrieval.
`ReactiveGeoCommands.GeoRadiusCommand`	`withDist()` Enables distance retrieval.
`ReactiveGeoCommands.GeoRadiusCommand`	`withFlag(RedisGeoCommands.GeoRadiusCommandArgs.Flag flag)` Applies command `flags`.
`static ReactiveGeoCommands.GeoRadiusCommand`	`within(Circle circle)` Creates a new `ReactiveGeoCommands.GeoRadiusCommand` given a `Circle`.
`static ReactiveGeoCommands.GeoRadiusCommand`	`within(Distance distance)` Creates a new `ReactiveGeoCommands.GeoRadiusCommand` given a `Distance`.
`static ReactiveGeoCommands.GeoRadiusCommand`	`withinFeet(double distance)` Creates a new `ReactiveGeoCommands.GeoRadiusCommand` given a distance in `RedisGeoCommands.DistanceUnit.FEET`.
`static ReactiveGeoCommands.GeoRadiusCommand`	`withinKilometers(double distance)` Creates a new `ReactiveGeoCommands.GeoRadiusCommand` given a distance in `RedisGeoCommands.DistanceUnit.KILOMETERS`.
`static ReactiveGeoCommands.GeoRadiusCommand`	`withinMeters(double distance)` Creates a new `ReactiveGeoCommands.GeoRadiusCommand` given a distance in `RedisGeoCommands.DistanceUnit.METERS`.
`static ReactiveGeoCommands.GeoRadiusCommand`	`withinMiles(double distance)` Creates a new `ReactiveGeoCommands.GeoRadiusCommand` 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 Detail
  - within
```
public static ReactiveGeoCommands.GeoRadiusCommand within(Distance distance)
```
    Creates a new ReactiveGeoCommands.GeoRadiusCommand given a Distance.
    
    Parameters:
    
    distance - must not be null.
    
    Returns:
    
    a new ReactiveGeoCommands.GeoRadiusCommand for a Distance.
  - withinMeters
```
public static ReactiveGeoCommands.GeoRadiusCommand withinMeters(double distance)
```
    Creates a new ReactiveGeoCommands.GeoRadiusCommand given a distance in RedisGeoCommands.DistanceUnit.METERS.
    
    Parameters:
    
    distance - must not be null.
    
    Returns:
    
    a new ReactiveGeoCommands.GeoRadiusCommand for a distance in RedisGeoCommands.DistanceUnit.METERS.
  - withinKilometers
```
public static ReactiveGeoCommands.GeoRadiusCommand withinKilometers(double distance)
```
    Creates a new ReactiveGeoCommands.GeoRadiusCommand given a distance in RedisGeoCommands.DistanceUnit.KILOMETERS.
    
    Parameters:
    
    distance - must not be null.
    
    Returns:
    
    a new ReactiveGeoCommands.GeoRadiusCommand for a distance in RedisGeoCommands.DistanceUnit.KILOMETERS.
  - withinMiles
```
public static ReactiveGeoCommands.GeoRadiusCommand withinMiles(double distance)
```
    Creates a new ReactiveGeoCommands.GeoRadiusCommand given a distance in RedisGeoCommands.DistanceUnit.MILES.
    
    Parameters:
    
    distance - must not be null.
    
    Returns:
    
    a new ReactiveGeoCommands.GeoRadiusCommand for a distance in RedisGeoCommands.DistanceUnit.MILES.
  - withinFeet
```
public static ReactiveGeoCommands.GeoRadiusCommand withinFeet(double distance)
```
    Creates a new ReactiveGeoCommands.GeoRadiusCommand given a distance in RedisGeoCommands.DistanceUnit.FEET.
    
    Parameters:
    
    distance - must not be null.
    
    Returns:
    
    a new ReactiveGeoCommands.GeoRadiusCommand for a distance in RedisGeoCommands.DistanceUnit.FEET.
  - within
```
public static ReactiveGeoCommands.GeoRadiusCommand within(Circle circle)
```
    Creates a new ReactiveGeoCommands.GeoRadiusCommand given a Circle.
    
    Parameters:
    
    circle - must not be null.
    
    Returns:
    
    a new ReactiveGeoCommands.GeoRadiusCommand for a Circle.
  - from
```
public ReactiveGeoCommands.GeoRadiusCommand from(Point center)
```
    Sets the center Point. Constructs a new command instance with all previously configured properties.
    
    Parameters:
    
    center - must not be null.
    
    Returns:
    
    a new ReactiveGeoCommands.GeoRadiusCommand with Point applied.
  - withFlag
```
public ReactiveGeoCommands.GeoRadiusCommand 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.GeoRadiusCommand with RedisGeoCommands.GeoRadiusCommandArgs.Flag applied.
  - withCoord
```
public ReactiveGeoCommands.GeoRadiusCommand withCoord()
```
    Enables coordinate retrieval. Constructs a new command instance with all previously configured properties.
    
    Returns:
    
    a new ReactiveGeoCommands.GeoRadiusCommand with RedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHCOORD applied.
  - withDist
```
public ReactiveGeoCommands.GeoRadiusCommand withDist()
```
    Enables distance retrieval. Constructs a new command instance with all previously configured properties.
    
    Returns:
    
    a new ReactiveGeoCommands.GeoRadiusCommand with RedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHDIST applied.
  - withArgs
```
public ReactiveGeoCommands.GeoRadiusCommand 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.GeoRadiusCommand with RedisGeoCommands.GeoRadiusCommandArgs applied.
  - limitTo
```
public ReactiveGeoCommands.GeoRadiusCommand limitTo(long limit)
```
    Applies the limit. Constructs a new command instance with all previously configured properties.
    
    Parameters:
    
    limit -
    
    Returns:
    
    a new ReactiveGeoCommands.GeoRadiusCommand with limit applied.
  - sort
```
public ReactiveGeoCommands.GeoRadiusCommand 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.GeoRadiusCommand with sort Sort.Direction applied.
  - orderByDistanceAsc
```
public ReactiveGeoCommands.GeoRadiusCommand orderByDistanceAsc()
```
    Applies ascending sort by distance. Constructs a new command instance with all previously configured properties.
    
    Returns:
    
    a new ReactiveGeoCommands.GeoRadiusCommand with sort Sort.Direction.ASC applied.
  - orderByDistanceDesc
```
public ReactiveGeoCommands.GeoRadiusCommand orderByDistanceDesc()
```
    Applies descending sort by distance. Constructs a new command instance with all previously configured properties.
    
    Returns:
    
    a new ReactiveGeoCommands.GeoRadiusCommand with sort Sort.Direction.DESC applied.
  - forKey
```
public ReactiveGeoCommands.GeoRadiusCommand 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.GeoRadiusCommand with key applied.
  - storeAt
```
public ReactiveGeoCommands.GeoRadiusCommand 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.GeoRadiusCommand.
  - storeDistAt
```
public ReactiveGeoCommands.GeoRadiusCommand storeDistAt(@Nullable
                                                        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.GeoRadiusCommand.
  - 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.
  - getPoint
```
@Nullable
public Point getPoint()
```
    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.

Class ReactiveGeoCommands.GeoRadiusCommand

Method Summary

Methods inherited from class org.springframework.data.redis.connection.ReactiveRedisConnection.KeyCommand

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.data.redis.connection.ReactiveRedisConnection.Command

Method Detail

within

withinMeters

withinKilometers

withinMiles

withinFeet

within

from

withFlag

withCoord

withDist

withArgs

limitTo

sort

orderByDistanceAsc

orderByDistanceDesc

forKey

storeAt

storeDistAt

getDirection

getDistance

getFlags

getLimit

getPoint

getStore

getStoreDist

getArgs