io.lettuce.core.cluster.api.async

Interface NodeSelectionListAsyncCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

NodeSelectionAsyncCommands<K,V>

public interface NodeSelectionListAsyncCommands<K,V>

Asynchronous executed commands on a node selection for Lists.

Since:

4.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method and Description
AsyncExecutions<V>	blmove(K source, K destination, LMoveArgs args, double timeout) Atomically returns and removes the first/last element (head/tail depending on the where from argument) of the list stored at source, and pushes the element at the first/last element (head/tail depending on the whereto argument) of the list stored at destination.
AsyncExecutions<V>	blmove(K source, K destination, LMoveArgs args, long timeout) Atomically returns and removes the first/last element (head/tail depending on the where from argument) of the list stored at source, and pushes the element at the first/last element (head/tail depending on the whereto argument) of the list stored at destination.
AsyncExecutions<List<V>>	blmovem(K source, K destination, BLMovemArgs args) Atomically returns and removes one or more elements from the head/tail of the list stored at source, and pushes them to the head/tail of the list stored at destination.
AsyncExecutions<KeyValue<K,List<V>>>	blmpop(double timeout, LMPopArgs args, K... keys) Remove and get the first/last elements in a list, or block until one is available.
AsyncExecutions<KeyValue<K,List<V>>>	blmpop(long timeout, LMPopArgs args, K... keys) Remove and get the first/last elements in a list, or block until one is available.
AsyncExecutions<KeyValue<K,V>>	blpop(double timeout, K... keys) Remove and get the first element in a list, or block until one is available.
AsyncExecutions<KeyValue<K,V>>	blpop(long timeout, K... keys) Remove and get the first element in a list, or block until one is available.
AsyncExecutions<KeyValue<K,V>>	brpop(double timeout, K... keys) Remove and get the last element in a list, or block until one is available.
AsyncExecutions<KeyValue<K,V>>	brpop(long timeout, K... keys) Remove and get the last element in a list, or block until one is available.
AsyncExecutions<V>	brpoplpush(double timeout, K source, K destination) Deprecated. since 7.7, use blmove(Object, Object, LMoveArgs, double) instead. This command is deprecated by Redis since version 6.2.0.
AsyncExecutions<V>	brpoplpush(long timeout, K source, K destination) Deprecated. since 7.7, use blmove(Object, Object, LMoveArgs, long) instead. This command is deprecated by Redis since version 6.2.0.
AsyncExecutions<V>	lindex(K key, long index) Get an element from a list by its index.
AsyncExecutions<Long>	linsert(K key, boolean before, V pivot, V value) Insert an element before or after another element in a list.
AsyncExecutions<Long>	llen(K key) Get the length of a list.
AsyncExecutions<V>	lmove(K source, K destination, LMoveArgs args) Atomically returns and removes the first/last element (head/tail depending on the where from argument) of the list stored at source, and pushes the element at the first/last element (head/tail depending on the whereto argument) of the list stored at destination.
AsyncExecutions<List<V>>	lmovem(K source, K destination, LMovemArgs args) Atomically returns and removes one or more elements from the head/tail of the list stored at source, and pushes them to the head/tail of the list stored at destination.
AsyncExecutions<KeyValue<K,List<V>>>	lmpop(LMPopArgs args, K... keys) Remove and get the first/last elements in a list.
AsyncExecutions<V>	lpop(K key) Remove and get the first element in a list.
AsyncExecutions<List<V>>	lpop(K key, long count) Remove and get the first count elements in a list.
AsyncExecutions<Long>	lpos(K key, V value) Return the index of matching elements inside a Redis list.
AsyncExecutions<List<Long>>	lpos(K key, V value, int count) Return the index of matching elements inside a Redis list using the COUNT option.
AsyncExecutions<List<Long>>	lpos(K key, V value, int count, LPosArgs args) Return the index of matching elements inside a Redis list using the COUNT option.
AsyncExecutions<Long>	lpos(K key, V value, LPosArgs args) Return the index of matching elements inside a Redis list.
AsyncExecutions<Long>	lpush(K key, V... values) Prepend one or multiple values to a list.
AsyncExecutions<Long>	lpushx(K key, V... values) Prepend values to a list, only if the list exists.
AsyncExecutions<List<V>>	lrange(K key, long start, long stop) Get a range of elements from a list.
AsyncExecutions<Long>	lrange(ValueStreamingChannel<V> channel, K key, long start, long stop) Get a range of elements from a list.
AsyncExecutions<Long>	lrem(K key, long count, V value) Remove elements from a list.
AsyncExecutions<String>	lset(K key, long index, V value) Set the value of an element in a list by its index.
AsyncExecutions<String>	ltrim(K key, long start, long stop) Trim a list to the specified range.
AsyncExecutions<V>	rpop(K key) Remove and get the last element in a list.
AsyncExecutions<List<V>>	rpop(K key, long count) Remove and get the last count elements in a list.
AsyncExecutions<V>	rpoplpush(K source, K destination) Deprecated. since 7.7, use lmove(Object, Object, LMoveArgs) instead. This command is deprecated by Redis since version 6.2.0.
AsyncExecutions<Long>	rpush(K key, V... values) Append one or multiple values to a list.
AsyncExecutions<Long>	rpushx(K key, V... values) Append values to a list, only if the list exists.

Method Detail

blmove

AsyncExecutions<V> blmove(K source,
                          K destination,
                          LMoveArgs args,
                          long timeout)

Atomically returns and removes the first/last element (head/tail depending on the where from argument) of the list stored at source, and pushes the element at the first/last element (head/tail depending on the whereto argument) of the list stored at destination. When source is empty, Redis will block the connection until another client pushes to it or until timeout is reached.

Parameters:

source - the source key.

destination - the destination type: key.

args - command arguments to configure source and destination directions.

timeout - the timeout in seconds.

Returns:

V bulk-string-reply the element being popped and pushed.

Since:

6.1

blmove

AsyncExecutions<V> blmove(K source,
                          K destination,
                          LMoveArgs args,
                          double timeout)

Atomically returns and removes the first/last element (head/tail depending on the where from argument) of the list stored at source, and pushes the element at the first/last element (head/tail depending on the whereto argument) of the list stored at destination. When source is empty, Redis will block the connection until another client pushes to it or until timeout is reached.

Parameters:

source - the source key.

destination - the destination type: key.

args - command arguments to configure source and destination directions.

timeout - the timeout in seconds.

Returns:

V bulk-string-reply the element being popped and pushed.

Since:

6.1.3

blmovem

AsyncExecutions<List<V>> blmovem(K source,
                                 K destination,
                                 BLMovemArgs args)

Atomically returns and removes one or more elements from the head/tail of the list stored at source, and pushes them to the head/tail of the list stored at destination. This is the blocking variant of lmovem(Object, Object, LMovemArgs). When args carry a COUNT the connection blocks only while source is empty; with EXACTLY it blocks until source holds enough elements or the configured timeout is reached. Without a count block this is equivalent to blmove(Object, Object, LMoveArgs, long). The blocking timeout is carried by args via BLMovemArgs.timeout(long) / BLMovemArgs.timeout(double) and defaults to 0 (block indefinitely).

Parameters:

source - the source key.

destination - the destination key.

args - command arguments to configure source and destination directions, the blocking timeout, and the optional count block.

Returns:

List<V> array-reply the elements being popped and pushed, or an empty list when the timeout was reached or EXACTLY cannot be satisfied.

Since:

7.7

blmpop

AsyncExecutions<KeyValue<K,List<V>>> blmpop(long timeout,
                                            LMPopArgs args,
                                            K... keys)

Remove and get the first/last elements in a list, or block until one is available.

Parameters:

timeout - the timeout in seconds.

args - the additional command arguments.

keys - the keys.

Returns:

KeyValue<K,V> array-reply specifically. null when key does not exist or the timeout was exceeded.

Since:

6.2

blmpop

AsyncExecutions<KeyValue<K,List<V>>> blmpop(double timeout,
                                            LMPopArgs args,
                                            K... keys)

Remove and get the first/last elements in a list, or block until one is available.

Parameters:

timeout - the timeout in seconds.

args - the additional command arguments.

keys - the keys.

Returns:

KeyValue<K,V> array-reply specifically. null when key does not exist or the timeout was exceeded.

Since:

6.2

blpop

AsyncExecutions<KeyValue<K,V>> blpop(long timeout,
                                     K... keys)

Remove and get the first element in a list, or block until one is available.

Parameters:

timeout - the timeout in seconds.

keys - the keys.

Returns:

KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element.

blpop

AsyncExecutions<KeyValue<K,V>> blpop(double timeout,
                                     K... keys)

Remove and get the first element in a list, or block until one is available.

Parameters:

timeout - the timeout in seconds.

keys - the keys.

Returns:

KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element.

Since:

6.1.3

brpop

AsyncExecutions<KeyValue<K,V>> brpop(long timeout,
                                     K... keys)

Remove and get the last element in a list, or block until one is available.

Parameters:

timeout - the timeout in seconds.

keys - the keys.

Returns:

KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element.

brpop

AsyncExecutions<KeyValue<K,V>> brpop(double timeout,
                                     K... keys)

Remove and get the last element in a list, or block until one is available.

Parameters:

timeout - the timeout in seconds.

keys - the keys.

Returns:

KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element.

Since:

6.1.3

brpoplpush

@Deprecated
AsyncExecutions<V> brpoplpush(long timeout,
                                          K source,
                                          K destination)

Deprecated. since 7.7, use blmove(Object, Object, LMoveArgs, long) instead. This command is deprecated by Redis since version 6.2.0.

Pop a value from a list, push it to another list and return it; or block until one is available.

Parameters:

timeout - the timeout in seconds.

source - the source key.

destination - the destination type: key.

Returns:

V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a.

brpoplpush

@Deprecated
AsyncExecutions<V> brpoplpush(double timeout,
                                          K source,
                                          K destination)

Deprecated. since 7.7, use blmove(Object, Object, LMoveArgs, double) instead. This command is deprecated by Redis since version 6.2.0.

Pop a value from a list, push it to another list and return it; or block until one is available.

Parameters:

timeout - the timeout in seconds.

source - the source key.

destination - the destination type: key.

Returns:

V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a.

Since:

6.1.3

lindex

AsyncExecutions<V> lindex(K key,
                          long index)

Get an element from a list by its index.

Parameters:

key - the key.

index - the index type: long.

Returns:

V bulk-string-reply the requested element, or null when index is out of range.

linsert

AsyncExecutions<Long> linsert(K key,
                              boolean before,
                              V pivot,
                              V value)

Insert an element before or after another element in a list.

Parameters:

key - the key.

before - the before.

pivot - the pivot.

value - the value.

Returns:

Long integer-reply the length of the list after the insert operation, or -1 when the value pivot was not found.

llen

AsyncExecutions<Long> llen(K key)

Get the length of a list.

Parameters:

key - the key.

Returns:

Long integer-reply the length of the list at key.

lmove

AsyncExecutions<V> lmove(K source,
                         K destination,
                         LMoveArgs args)

Atomically returns and removes the first/last element (head/tail depending on the where from argument) of the list stored at source, and pushes the element at the first/last element (head/tail depending on the whereto argument) of the list stored at destination.

Parameters:

source - the source key.

destination - the destination type: key.

args - command arguments to configure source and destination directions.

Returns:

V bulk-string-reply the element being popped and pushed.

Since:

6.1

lmovem

AsyncExecutions<List<V>> lmovem(K source,
                                K destination,
                                LMovemArgs args)

Atomically returns and removes one or more elements from the head/tail of the list stored at source, and pushes them to the head/tail of the list stored at destination. The number of elements and their ordering are configured through args: COUNT moves up-to count elements, EXACTLY moves exactly count elements or returns an empty list when source does not hold enough elements. Without a count block this is equivalent to lmove(Object, Object, LMoveArgs).

Parameters:

source - the source key.

destination - the destination key.

args - command arguments to configure source and destination directions and the optional count block.

Returns:

List<V> array-reply the elements being popped and pushed, or an empty list when EXACTLY cannot be satisfied.

Since:

7.7

lmpop

AsyncExecutions<KeyValue<K,List<V>>> lmpop(LMPopArgs args,
                                           K... keys)

Remove and get the first/last elements in a list.

Parameters:

args - the additional command arguments.

keys - the keys.

Returns:

KeyValue<K,V> array-reply specifically. null when key does not exist.

Since:

6.2

lpop

AsyncExecutions<V> lpop(K key)

Remove and get the first element in a list.

Parameters:

key - the key.

Returns:

V bulk-string-reply the value of the first element, or null when key does not exist.

lpop

AsyncExecutions<List<V>> lpop(K key,
                              long count)

Remove and get the first count elements in a list.

Parameters:

key - the key.

count - the number of elements to return.

Returns:

@return List<V> array-reply list of the first count elements, or null when key does not exist.

Since:

6.1

lpos

AsyncExecutions<Long> lpos(K key,
                           V value)

Return the index of matching elements inside a Redis list. By default, when no options are given, it will scan the list from head to tail, looking for the first match of "element". If the element is found, its index (the zero-based position in the list) is returned. Otherwise, if no match is found, null is returned. The returned elements indexes are always referring to what lindex(java.lang.Object, long) would return. So first element from head is 0, and so forth.

Parameters:

key - the key.

value - the element to search for.

Returns:

V integer-reply representing the matching element, or null if there is no match.

Since:

5.3.2

lpos

AsyncExecutions<Long> lpos(K key,
                           V value,
                           LPosArgs args)

Return the index of matching elements inside a Redis list. By default, when no options are given, it will scan the list from head to tail, looking for the first match of "element". If the element is found, its index (the zero-based position in the list) is returned. Otherwise, if no match is found, null is returned. The returned elements indexes are always referring to what lindex(java.lang.Object, long) would return. So first element from head is 0, and so forth.

Parameters:

key - the key.

value - the element to search for.

args - command arguments to configureFIRST and MAXLEN options.

Returns:

V integer-reply representing the matching element, or null if there is no match.

Since:

5.3.2

lpos

AsyncExecutions<List<Long>> lpos(K key,
                                 V value,
                                 int count)

Return the index of matching elements inside a Redis list using the COUNT option. By default, when no options are given, it will scan the list from head to tail, looking for the first match of "element". The returned elements indexes are always referring to what lindex(java.lang.Object, long) would return. So first element from head is 0, and so forth.

Parameters:

key - the key.

value - the element to search for.

count - limit the number of matches.

Returns:

V integer-reply representing the matching elements, or empty if there is no match.

Since:

5.3.2

lpos

AsyncExecutions<List<Long>> lpos(K key,
                                 V value,
                                 int count,
                                 LPosArgs args)

Return the index of matching elements inside a Redis list using the COUNT option. By default, when no options are given, it will scan the list from head to tail, looking for the first match of "element". The returned elements indexes are always referring to what lindex(java.lang.Object, long) would return. So first element from head is 0, and so forth.

Parameters:

key - the key.

value - the element to search for.

count - limit the number of matches.

args - command arguments to configureFIRST and MAXLEN options.

Returns:

V integer-reply representing the matching elements, or empty if there is no match.

Since:

5.3.2

lpush

AsyncExecutions<Long> lpush(K key,
                            V... values)

Prepend one or multiple values to a list.

Parameters:

key - the key.

values - the value.

Returns:

Long integer-reply the length of the list after the push operations.

lpushx

AsyncExecutions<Long> lpushx(K key,
                             V... values)

Prepend values to a list, only if the list exists.

Parameters:

key - the key.

values - the values.

Returns:

Long integer-reply the length of the list after the push operation.

lrange

AsyncExecutions<List<V>> lrange(K key,
                                long start,
                                long stop)

Get a range of elements from a list.

Parameters:

key - the key.

start - the start type: long.

stop - the stop type: long.

Returns:

List<V> array-reply list of elements in the specified range.

lrange

AsyncExecutions<Long> lrange(ValueStreamingChannel<V> channel,
                             K key,
                             long start,
                             long stop)

Get a range of elements from a list.

Parameters:

channel - the channel.

key - the key.

start - the start type: long.

stop - the stop type: long.

Returns:

Long count of elements in the specified range.

lrem

AsyncExecutions<Long> lrem(K key,
                           long count,
                           V value)

Remove elements from a list.

Parameters:

key - the key.

count - the count type: long.

value - the value.

Returns:

Long integer-reply the number of removed elements.

lset

AsyncExecutions<String> lset(K key,
                             long index,
                             V value)

Set the value of an element in a list by its index.

Parameters:

key - the key.

index - the index type: long.

value - the value.

Returns:

String simple-string-reply.

ltrim

AsyncExecutions<String> ltrim(K key,
                              long start,
                              long stop)

Trim a list to the specified range.

Parameters:

key - the key.

start - the start type: long.

stop - the stop type: long.

Returns:

String simple-string-reply.

rpop

AsyncExecutions<V> rpop(K key)

Remove and get the last element in a list.

Parameters:

key - the key.

Returns:

V bulk-string-reply the value of the last element, or null when key does not exist.

rpop

AsyncExecutions<List<V>> rpop(K key,
                              long count)

Remove and get the last count elements in a list.

Parameters:

key - the key.

count - the number of elements to return.

Returns:

List<V> array-reply list of the last count elements, or null when key does not exist.

Since:

6.1

rpoplpush

@Deprecated
AsyncExecutions<V> rpoplpush(K source,
                                         K destination)

Deprecated. since 7.7, use lmove(Object, Object, LMoveArgs) instead. This command is deprecated by Redis since version 6.2.0.

Remove the last element in a list, append it to another list and return it.

Parameters:

source - the source key.

destination - the destination type: key.

Returns:

V bulk-string-reply the element being popped and pushed.

rpush

AsyncExecutions<Long> rpush(K key,
                            V... values)

Append one or multiple values to a list.

Parameters:

key - the key.

values - the value.

Returns:

Long integer-reply the length of the list after the push operation.

rpushx

AsyncExecutions<Long> rpushx(K key,
                             V... values)

Append values to a list, only if the list exists.

Parameters:

key - the key.

values - the values.

Returns:

Long integer-reply the length of the list after the push operation.