io.lettuce.core.cluster.api.sync

Interface NodeSelectionListCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

NodeSelectionCommands<K,V>

public interface NodeSelectionListCommands<K,V>

Synchronous executed commands on a node selection for Lists.

Since:

4.0

Author:

Mark Paluch

Generated class:

by io.lettuce.apigenerator.CreateSyncNodeSelectionClusterApi

Method Summary

Modifier and Type	Method and Description
Executions<KeyValue<K,V>>	blpop(long timeout, K... keys) Remove and get the first element in a list, or block until one is available.
Executions<KeyValue<K,V>>	brpop(long timeout, K... keys) Remove and get the last element in a list, or block until one is available.
Executions<V>	brpoplpush(long timeout, K source, K destination) Pop a value from a list, push it to another list and return it; or block until one is available.
Executions<V>	lindex(K key, long index) Get an element from a list by its index.
Executions<Long>	linsert(K key, boolean before, V pivot, V value) Insert an element before or after another element in a list.
Executions<Long>	llen(K key) Get the length of a list.
Executions<V>	lpop(K key) Remove and get the first element in a list.
Executions<Long>	lpush(K key, V... values) Prepend one or multiple values to a list.
Executions<Long>	lpushx(K key, V... values) Prepend values to a list, only if the list exists.
Executions<List<V>>	lrange(K key, long start, long stop) Get a range of elements from a list.
Executions<Long>	lrange(ValueStreamingChannel<V> channel, K key, long start, long stop) Get a range of elements from a list.
Executions<Long>	lrem(K key, long count, V value) Remove elements from a list.
Executions<String>	lset(K key, long index, V value) Set the value of an element in a list by its index.
Executions<String>	ltrim(K key, long start, long stop) Trim a list to the specified range.
Executions<V>	rpop(K key) Remove and get the last element in a list.
Executions<V>	rpoplpush(K source, K destination) Remove the last element in a list, append it to another list and return it.
Executions<Long>	rpush(K key, V... values) Append one or multiple values to a list.
Executions<Long>	rpushx(K key, V... values) Append values to a list, only if the list exists.

Method Detail

blpop

Executions<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.

brpop

Executions<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.

brpoplpush

Executions<V> brpoplpush(long timeout,
                         K source,
                         K destination)

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

lindex

Executions<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

Executions<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

Executions<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.

lpop

Executions<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.

lpush

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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

Executions<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.

rpoplpush

Executions<V> rpoplpush(K source,
                        K destination)

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

Executions<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

Executions<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.