io.lettuce.core.cluster.api.async

Interface NodeSelectionSetAsyncCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

NodeSelectionAsyncCommands<K,V>

public interface NodeSelectionSetAsyncCommands<K,V>

Asynchronous executed commands on a node selection for Sets.

Since:

4.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method and Description
AsyncExecutions<Long>	sadd(K key, V... members) Add one or more members to a set.
AsyncExecutions<Long>	scard(K key) Get the number of members in a set.
AsyncExecutions<Set<V>>	sdiff(K... keys) Subtract multiple sets.
AsyncExecutions<Long>	sdiff(ValueStreamingChannel<V> channel, K... keys) Subtract multiple sets.
AsyncExecutions<Long>	sdiffcard(K key1, K key2) Compute the number of elements in the difference between the set stored at key1 and the set stored at key2, without returning the difference itself.
AsyncExecutions<Long>	sdiffcard(K key1, K key2, SDiffCardArgs sdiffCardArgs) Compute the number of elements in the difference between the set stored at key1 and the set stored at key2, without returning the difference itself, applying SDiffCardArgs.
AsyncExecutions<Long>	sdiffcard(List<K> keys) Compute the number of elements in the difference between the set stored at the first key and the sets stored at all successive keys, without returning the difference itself.
AsyncExecutions<Long>	sdiffcard(List<K> keys, SDiffCardArgs sdiffCardArgs) Compute the number of elements in the difference between the set stored at the first key and the sets stored at all successive keys, without returning the difference itself, applying SDiffCardArgs.
AsyncExecutions<Long>	sdiffstore(K destination, K... keys) Subtract multiple sets and store the resulting set in a key.
AsyncExecutions<Set<V>>	sinter(K... keys) Intersect multiple sets.
AsyncExecutions<Long>	sinter(ValueStreamingChannel<V> channel, K... keys) Intersect multiple sets.
AsyncExecutions<Long>	sintercard(K... keys) This command works exactly like sinter(java.lang.Object[]) but instead of returning the result set, it returns just the cardinality of the result.
AsyncExecutions<Long>	sintercard(long limit, K... keys) This command works exactly like sinter(java.lang.Object[]) but instead of returning the result set, it returns just the cardinality of the result.
AsyncExecutions<Long>	sinterstore(K destination, K... keys) Intersect multiple sets and store the resulting set in a key.
AsyncExecutions<Boolean>	sismember(K key, V member) Determine if a given value is a member of a set.
AsyncExecutions<Set<V>>	smembers(K key) Get all the members in a set.
AsyncExecutions<Long>	smembers(ValueStreamingChannel<V> channel, K key) Get all the members in a set.
AsyncExecutions<List<Boolean>>	smismember(K key, V... members) Returns whether each member is a member of the set stored at key.
AsyncExecutions<Boolean>	smove(K source, K destination, V member) Move a member from one set to another.
AsyncExecutions<V>	spop(K key) Remove and return a random member from a set.
AsyncExecutions<Set<V>>	spop(K key, long count) Remove and return one or multiple random members from a set.
AsyncExecutions<V>	srandmember(K key) Get one random member from a set.
AsyncExecutions<List<V>>	srandmember(K key, long count) Get one or multiple random members from a set.
AsyncExecutions<Long>	srandmember(ValueStreamingChannel<V> channel, K key, long count) Get one or multiple random members from a set.
AsyncExecutions<Long>	srem(K key, V... members) Remove one or more members from a set.
AsyncExecutions<ValueScanCursor<V>>	sscan(K key) Incrementally iterate Set elements.
AsyncExecutions<ValueScanCursor<V>>	sscan(K key, ScanArgs scanArgs) Incrementally iterate Set elements.
AsyncExecutions<ValueScanCursor<V>>	sscan(K key, ScanCursor scanCursor) Incrementally iterate Set elements.
AsyncExecutions<ValueScanCursor<V>>	sscan(K key, ScanCursor scanCursor, ScanArgs scanArgs) Incrementally iterate Set elements.
AsyncExecutions<StreamScanCursor>	sscan(ValueStreamingChannel<V> channel, K key) Incrementally iterate Set elements.
AsyncExecutions<StreamScanCursor>	sscan(ValueStreamingChannel<V> channel, K key, ScanArgs scanArgs) Incrementally iterate Set elements.
AsyncExecutions<StreamScanCursor>	sscan(ValueStreamingChannel<V> channel, K key, ScanCursor scanCursor) Incrementally iterate Set elements.
AsyncExecutions<StreamScanCursor>	sscan(ValueStreamingChannel<V> channel, K key, ScanCursor scanCursor, ScanArgs scanArgs) Incrementally iterate Set elements.
AsyncExecutions<Set<V>>	sunion(K... keys) Add multiple sets.
AsyncExecutions<Long>	sunion(ValueStreamingChannel<V> channel, K... keys) Add multiple sets.
AsyncExecutions<Long>	sunioncard(K key1, K key2) Compute the number of distinct elements in the union of the sets stored at key1 and key2 without returning the union itself.
AsyncExecutions<Long>	sunioncard(K key1, K key2, SUnionCardArgs sunionCardArgs) Compute the number of distinct elements in the union of the sets stored at key1 and key2 without returning the union itself, applying SUnionCardArgs.
AsyncExecutions<Long>	sunioncard(List<K> keys) Compute the number of distinct elements in the union of the sets stored at the given keys without returning the union itself.
AsyncExecutions<Long>	sunioncard(List<K> keys, SUnionCardArgs sunionCardArgs) Compute the number of distinct elements in the union of the sets stored at the given keys without returning the union itself, applying SUnionCardArgs.
AsyncExecutions<Long>	sunionstore(K destination, K... keys) Add multiple sets and store the resulting set in a key.

Method Detail

sadd

AsyncExecutions<Long> sadd(K key,
                           V... members)

Add one or more members to a set.

Parameters:

key - the key.

members - the member type: value.

Returns:

Long integer-reply the number of elements that were added to the set, not including all the elements already present into the set.

scard

AsyncExecutions<Long> scard(K key)

Get the number of members in a set.

Parameters:

key - the key.

Returns:

Long integer-reply the cardinality (number of elements) of the set, or false if key does not exist.

sdiff

AsyncExecutions<Set<V>> sdiff(K... keys)

Subtract multiple sets.

Parameters:

keys - the key.

Returns:

Set<V> array-reply list with members of the resulting set.

sdiff

AsyncExecutions<Long> sdiff(ValueStreamingChannel<V> channel,
                            K... keys)

Subtract multiple sets.

Parameters:

channel - the channel.

keys - the keys.

Returns:

Long count of members of the resulting set.

sdiffcard

AsyncExecutions<Long> sdiffcard(K key1,
                                K key2)

Compute the number of elements in the difference between the set stored at key1 and the set stored at key2, without returning the difference itself. Non-existing keys are treated as empty sets; when key1 does not exist the result is 0.

Parameters:

key1 - the key of the set to subtract from, must not be null.

key2 - the key of the set to subtract, must not be null.

Returns:

the cardinality of the difference.

Throws:

IllegalArgumentException - if key1 or key2 is null.

Since:

7.7

sdiffcard

AsyncExecutions<Long> sdiffcard(List<K> keys)

Compute the number of elements in the difference between the set stored at the first key and the sets stored at all successive keys, without returning the difference itself. Non-existing keys are treated as empty sets; when the first key does not exist the result is 0.

Parameters:

keys - the keys, must not be null or empty. The first key is the set to subtract from, all successive keys are subtracted.

Returns:

the cardinality of the difference.

Throws:

IllegalArgumentException - if keys is null or empty.

Since:

7.7

sdiffcard

AsyncExecutions<Long> sdiffcard(K key1,
                                K key2,
                                SDiffCardArgs sdiffCardArgs)

Compute the number of elements in the difference between the set stored at key1 and the set stored at key2, without returning the difference itself, applying SDiffCardArgs. Non-existing keys are treated as empty sets; when key1 does not exist the result is 0.

Parameters:

key1 - the key of the set to subtract from, must not be null.

key2 - the key of the set to subtract, must not be null.

sdiffCardArgs - the command arguments (LIMIT), must not be null.

Returns:

the cardinality of the difference; when a limit is set, at most that limit.

Throws:

IllegalArgumentException - if key1, key2 or sdiffCardArgs is null.

Since:

7.7

sdiffcard

AsyncExecutions<Long> sdiffcard(List<K> keys,
                                SDiffCardArgs sdiffCardArgs)

Compute the number of elements in the difference between the set stored at the first key and the sets stored at all successive keys, without returning the difference itself, applying SDiffCardArgs. Non-existing keys are treated as empty sets; when the first key does not exist the result is 0.

Parameters:

keys - the keys, must not be null or empty. The first key is the set to subtract from, all successive keys are subtracted.

sdiffCardArgs - the command arguments (LIMIT), must not be null.

Returns:

the cardinality of the difference; when a limit is set, at most that limit.

Throws:

IllegalArgumentException - if keys is null or empty, or sdiffCardArgs is null.

Since:

7.7

sdiffstore

AsyncExecutions<Long> sdiffstore(K destination,
                                 K... keys)

Subtract multiple sets and store the resulting set in a key.

Parameters:

destination - the destination type: key.

keys - the key.

Returns:

Long integer-reply the number of elements in the resulting set.

sinter

AsyncExecutions<Set<V>> sinter(K... keys)

Intersect multiple sets.

Parameters:

keys - the key.

Returns:

Set<V> array-reply list with members of the resulting set.

sinter

AsyncExecutions<Long> sinter(ValueStreamingChannel<V> channel,
                             K... keys)

Intersect multiple sets.

Parameters:

channel - the channel.

keys - the keys.

Returns:

Long count of members of the resulting set.

sintercard

AsyncExecutions<Long> sintercard(K... keys)

This command works exactly like sinter(java.lang.Object[]) but instead of returning the result set, it returns just the cardinality of the result.

Parameters:

keys - the keys.

Returns:

The cardinality of the set which would result from the intersection of all the given sets.

Since:

6.2

sintercard

AsyncExecutions<Long> sintercard(long limit,
                                 K... keys)

This command works exactly like sinter(java.lang.Object[]) but instead of returning the result set, it returns just the cardinality of the result.

Parameters:

limit - If the intersection cardinality reaches limit partway through the computation, the algorithm will exit and yield limit as the cardinality.

keys - the keys.

Returns:

The cardinality of the set which would result from the intersection of all the given sets.

Since:

6.2

sinterstore

AsyncExecutions<Long> sinterstore(K destination,
                                  K... keys)

Intersect multiple sets and store the resulting set in a key.

Parameters:

destination - the destination type: key.

keys - the key.

Returns:

Long integer-reply the number of elements in the resulting set.

sismember

AsyncExecutions<Boolean> sismember(K key,
                                   V member)

Determine if a given value is a member of a set.

Parameters:

key - the key.

member - the member type: value.

Returns:

Boolean integer-reply specifically: true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist.

smembers

AsyncExecutions<Set<V>> smembers(K key)

Get all the members in a set.

Parameters:

key - the key.

Returns:

Set<V> array-reply all elements of the set.

smembers

AsyncExecutions<Long> smembers(ValueStreamingChannel<V> channel,
                               K key)

Get all the members in a set.

Parameters:

channel - the channel.

key - the keys.

Returns:

Long count of members of the resulting set.

smismember

AsyncExecutions<List<Boolean>> smismember(K key,
                                          V... members)

Returns whether each member is a member of the set stored at key.

Parameters:

key - the key.

members - the member type: value.

Returns:

List<Boolean> array-reply list representing the membership of the given elements, in the same order as they are requested.

Since:

6.1

smove

AsyncExecutions<Boolean> smove(K source,
                               K destination,
                               V member)

Move a member from one set to another.

Parameters:

source - the source key.

destination - the destination type: key.

member - the member type: value.

Returns:

Boolean integer-reply specifically: true if the element is moved. false if the element is not a member of source and no operation was performed.

spop

AsyncExecutions<V> spop(K key)

Remove and return a random member from a set.

Parameters:

key - the key.

Returns:

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

spop

AsyncExecutions<Set<V>> spop(K key,
                             long count)

Remove and return one or multiple random members from a set.

Parameters:

key - the key.

count - number of members to pop.

Returns:

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

srandmember

AsyncExecutions<V> srandmember(K key)

Get one random member from a set.

Parameters:

key - the key.

Returns:

V bulk-string-reply without the additional count argument the command returns a Bulk Reply with the randomly selected element, or null when key does not exist.

srandmember

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

Get one or multiple random members from a set.

Parameters:

key - the key.

count - the count type: long.

Returns:

Set<V> bulk-string-reply without the additional count argument the command returns a Bulk Reply with the randomly selected element, or null when key does not exist.

srandmember

AsyncExecutions<Long> srandmember(ValueStreamingChannel<V> channel,
                                  K key,
                                  long count)

Get one or multiple random members from a set.

Parameters:

channel - streaming channel that receives a call for every value.

key - the key.

count - the count.

Returns:

Long count of members of the resulting set.

srem

AsyncExecutions<Long> srem(K key,
                           V... members)

Remove one or more members from a set.

Parameters:

key - the key.

members - the member type: value.

Returns:

Long integer-reply the number of members that were removed from the set, not including non existing members.

sunion

AsyncExecutions<Set<V>> sunion(K... keys)

Add multiple sets.

Parameters:

keys - the key.

Returns:

Set<V> array-reply list with members of the resulting set.

sunion

AsyncExecutions<Long> sunion(ValueStreamingChannel<V> channel,
                             K... keys)

Add multiple sets.

Parameters:

channel - streaming channel that receives a call for every value.

keys - the keys.

Returns:

Long count of members of the resulting set.

sunioncard

AsyncExecutions<Long> sunioncard(K key1,
                                 K key2)

Compute the number of distinct elements in the union of the sets stored at key1 and key2 without returning the union itself. Non-existing keys are treated as empty sets.

Parameters:

key1 - the key of the first set, must not be null.

key2 - the key of the second set, must not be null.

Returns:

the cardinality of the union.

Throws:

IllegalArgumentException - if key1 or key2 is null.

Since:

7.7

sunioncard

AsyncExecutions<Long> sunioncard(List<K> keys)

Compute the number of distinct elements in the union of the sets stored at the given keys without returning the union itself. Non-existing keys are treated as empty sets.

Parameters:

keys - the keys of the sets to union, must not be null or empty.

Returns:

the cardinality of the union.

Throws:

IllegalArgumentException - if keys is null or empty.

Since:

7.7

sunioncard

AsyncExecutions<Long> sunioncard(K key1,
                                 K key2,
                                 SUnionCardArgs sunionCardArgs)

Compute the number of distinct elements in the union of the sets stored at key1 and key2 without returning the union itself, applying SUnionCardArgs. Non-existing keys are treated as empty sets.

Parameters:

key1 - the key of the first set, must not be null.

key2 - the key of the second set, must not be null.

sunionCardArgs - the command arguments (APPROX, LIMIT), must not be null.

Returns:

the cardinality of the union; when a limit is set, at most that limit.

Throws:

IllegalArgumentException - if key1, key2 or sunionCardArgs is null.

Since:

7.7

sunioncard

AsyncExecutions<Long> sunioncard(List<K> keys,
                                 SUnionCardArgs sunionCardArgs)

Compute the number of distinct elements in the union of the sets stored at the given keys without returning the union itself, applying SUnionCardArgs. Non-existing keys are treated as empty sets.

Parameters:

keys - the keys of the sets to union, must not be null or empty.

sunionCardArgs - the command arguments (APPROX, LIMIT), must not be null.

Returns:

the cardinality of the union; when a limit is set, at most that limit.

Throws:

IllegalArgumentException - if keys is null or empty, or sunionCardArgs is null.

Since:

7.7

sunionstore

AsyncExecutions<Long> sunionstore(K destination,
                                  K... keys)

Add multiple sets and store the resulting set in a key.

Parameters:

destination - the destination type: key.

keys - the key.

Returns:

Long integer-reply the number of elements in the resulting set.

sscan

AsyncExecutions<ValueScanCursor<V>> sscan(K key)

Incrementally iterate Set elements.

Parameters:

key - the key.

Returns:

ValueScanCursor<V> scan cursor.

sscan

AsyncExecutions<ValueScanCursor<V>> sscan(K key,
                                          ScanArgs scanArgs)

Incrementally iterate Set elements.

Parameters:

key - the key.

scanArgs - scan arguments.

Returns:

ValueScanCursor<V> scan cursor.

sscan

AsyncExecutions<ValueScanCursor<V>> sscan(K key,
                                          ScanCursor scanCursor,
                                          ScanArgs scanArgs)

Incrementally iterate Set elements.

Parameters:

key - the key.

scanCursor - cursor to resume from a previous scan, must not be null.

scanArgs - scan arguments.

Returns:

ValueScanCursor<V> scan cursor.

sscan

AsyncExecutions<ValueScanCursor<V>> sscan(K key,
                                          ScanCursor scanCursor)

Incrementally iterate Set elements.

Parameters:

key - the key.

scanCursor - cursor to resume from a previous scan, must not be null.

Returns:

ValueScanCursor<V> scan cursor.

sscan

AsyncExecutions<StreamScanCursor> sscan(ValueStreamingChannel<V> channel,
                                        K key)

Incrementally iterate Set elements.

Parameters:

channel - streaming channel that receives a call for every value.

key - the key.

Returns:

StreamScanCursor scan cursor.

sscan

AsyncExecutions<StreamScanCursor> sscan(ValueStreamingChannel<V> channel,
                                        K key,
                                        ScanArgs scanArgs)

Incrementally iterate Set elements.

Parameters:

channel - streaming channel that receives a call for every value.

key - the key.

scanArgs - scan arguments.

Returns:

StreamScanCursor scan cursor.

sscan

AsyncExecutions<StreamScanCursor> sscan(ValueStreamingChannel<V> channel,
                                        K key,
                                        ScanCursor scanCursor,
                                        ScanArgs scanArgs)

Incrementally iterate Set elements.

Parameters:

channel - streaming channel that receives a call for every value.

key - the key.

scanCursor - cursor to resume from a previous scan, must not be null.

scanArgs - scan arguments.

Returns:

StreamScanCursor scan cursor.

sscan

AsyncExecutions<StreamScanCursor> sscan(ValueStreamingChannel<V> channel,
                                        K key,
                                        ScanCursor scanCursor)

Incrementally iterate Set elements.

Parameters:

channel - streaming channel that receives a call for every value.

key - the key.

scanCursor - cursor to resume from a previous scan, must not be null.

Returns:

StreamScanCursor scan cursor.