Package io.quarkus.redis.datasource.geo

Class GeoSearchStoreArgs<V>

java.lang.Object

io.quarkus.redis.datasource.geo.GeoSearchStoreArgs<V>

All Implemented Interfaces:

RedisCommandExtraArguments

public class GeoSearchStoreArgs<V>
extends Object
implements RedisCommandExtraArguments

Constructor Summary

Constructors

Constructor	Description
GeoSearchStoreArgs()

Method Summary

Modifier and Type	Method	Description
GeoSearchStoreArgs<V>	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.
GeoSearchStoreArgs<V>	ascending()	Use ASC order (from small to large).
GeoSearchStoreArgs<V>	byBox(double width, double height, GeoUnit unit)	Search inside circular area according to given radius.
GeoSearchStoreArgs<V>	byRadius(double radius, GeoUnit unit)	Search inside circular area according to given radius.
GeoSearchStoreArgs<V>	count(long count)	By default all the matching items are returned.
GeoSearchStoreArgs<V>	descending()	Use DESC order (from large to small).
GeoSearchStoreArgs<V>	fromMember(V member)	Use the position of the given existing member in the sorted set.
List<Object>	toArgs(Codec codec)

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

Constructor Detail

GeoSearchStoreArgs

public GeoSearchStoreArgs()

Method Detail

fromMember

public GeoSearchStoreArgs<V> fromMember(V member)

Use the position of the given existing member in the sorted set.

Parameters:

member - the member, must not be null

Returns:

the current GeoSearchStoreArgs

byRadius

public GeoSearchStoreArgs<V> byRadius(double radius,
                                      GeoUnit unit)

Search inside circular area according to given radius.

Parameters:

radius - the radius value

unit - the unit

Returns:

the current GeoSearchStoreArgs

byBox

public GeoSearchStoreArgs<V> byBox(double width,
                                   double height,
                                   GeoUnit unit)

Search inside circular area according to given radius.

Parameters:

width - the width of the box

height - the height of the box

unit - the unit

Returns:

the current GeoSearchStoreArgs

ascending

public GeoSearchStoreArgs<V> ascending()

Use ASC order (from small to large).

Returns:

the current GeoSearchStoreArgs

descending

public GeoSearchStoreArgs<V> descending()

Use DESC order (from large to small).

Returns:

the current GeoSearchStoreArgs

count

public GeoSearchStoreArgs<V> 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 the COUNT <count> option.

Parameters:

count - the count value

Returns:

the current GeoSearchStoreArgs

any

public GeoSearchStoreArgs<V> 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 requires count to be set.

Returns:

the current GeoSearchStoreArgs

toArgs

public List<Object> toArgs(Codec codec)

Specified by:

toArgs in interface RedisCommandExtraArguments

Parameters:

codec - an optional encoder to encode some of the values

Returns:

the list of arguments.