NodeSelectionStreamCommands (Lettuce 5.2.0.RELEASE API)

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

NodeSelectionAsyncCommands<K,V>, NodeSelectionCommands<K,V>
```
public interface NodeSelectionStreamCommands<K,V>
```
Synchronous executed commands on a node selection for Streams.

Since:

5.1

Author:

Mark Paluch

Generated class:

by io.lettuce.apigenerator.CreateSyncNodeSelectionClusterApi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Executions<Long>`	`xack(K key, K group, String... messageIds)` Acknowledge one or more messages as processed.
`Executions<String>`	`xadd(K key, Map<K,V> body)` Append a message to the stream `key`.
`Executions<String>`	`xadd(K key, Object... keysAndValues)` Append a message to the stream `key`.
`Executions<String>`	`xadd(K key, XAddArgs args, Map<K,V> body)` Append a message to the stream `key`.
`Executions<String>`	`xadd(K key, XAddArgs args, Object... keysAndValues)` Append a message to the stream `key`.
`Executions<List<StreamMessage<K,V>>>`	`xclaim(K key, Consumer<K> consumer, long minIdleTime, String... messageIds)` Gets ownership of one or multiple messages in the Pending Entries List of a given stream consumer group.
`Executions<List<StreamMessage<K,V>>>`	`xclaim(K key, Consumer<K> consumer, XClaimArgs args, String... messageIds)` Gets ownership of one or multiple messages in the Pending Entries List of a given stream consumer group.
`Executions<Long>`	`xdel(K key, String... messageIds)` Removes the specified entries from the stream.
`Executions<String>`	`xgroupCreate(XReadArgs.StreamOffset<K> streamOffset, K group)` Create a consumer group.
`Executions<String>`	`xgroupCreate(XReadArgs.StreamOffset<K> streamOffset, K group, XGroupCreateArgs args)` Create a consumer group.
`Executions<Boolean>`	`xgroupDelconsumer(K key, Consumer<K> consumer)` Delete a consumer from a consumer group.
`Executions<Boolean>`	`xgroupDestroy(K key, K group)` Destroy a consumer group.
`Executions<String>`	`xgroupSetid(XReadArgs.StreamOffset<K> streamOffset, K group)` Set the current `group` id.
`Executions<List<Object>>`	`xinfoConsumers(K key, K group)` Retrieve information about consumer groups of group `group` and stream at `key`.
`Executions<List<Object>>`	`xinfoGroups(K key)` Retrieve information about the stream consumer groups at `key`.
`Executions<List<Object>>`	`xinfoStream(K key)` Retrieve information about the stream at `key`.
`Executions<Long>`	`xlen(K key)` Get the length of a steam.
`Executions<List<Object>>`	`xpending(K key, Consumer<K> consumer, Range<String> range, Limit limit)` Read pending messages from a stream within a specific `Range`.
`Executions<List<Object>>`	`xpending(K key, K group)` Read pending messages from a stream for a `group`.
`Executions<List<Object>>`	`xpending(K key, K group, Range<String> range, Limit limit)` Read pending messages from a stream within a specific `Range`.
`Executions<List<StreamMessage<K,V>>>`	`xrange(K key, Range<String> range)` Read messages from a stream within a specific `Range`.
`Executions<List<StreamMessage<K,V>>>`	`xrange(K key, Range<String> range, Limit limit)` Read messages from a stream within a specific `Range` applying a `Limit`.
`Executions<List<StreamMessage<K,V>>>`	`xread(XReadArgs.StreamOffset<K>... streams)` Read messages from one or more `XReadArgs.StreamOffset`s.
`Executions<List<StreamMessage<K,V>>>`	`xread(XReadArgs args, XReadArgs.StreamOffset<K>... streams)` Read messages from one or more `XReadArgs.StreamOffset`s.
`Executions<List<StreamMessage<K,V>>>`	`xreadgroup(Consumer<K> consumer, XReadArgs.StreamOffset<K>... streams)` Read messages from one or more `XReadArgs.StreamOffset`s using a consumer group.
`Executions<List<StreamMessage<K,V>>>`	`xreadgroup(Consumer<K> consumer, XReadArgs args, XReadArgs.StreamOffset<K>... streams)` Read messages from one or more `XReadArgs.StreamOffset`s using a consumer group.
`Executions<List<StreamMessage<K,V>>>`	`xrevrange(K key, Range<String> range)` Read messages from a stream within a specific `Range` in reverse order.
`Executions<List<StreamMessage<K,V>>>`	`xrevrange(K key, Range<String> range, Limit limit)` Read messages from a stream within a specific `Range` applying a `Limit` in reverse order.
`Executions<Long>`	`xtrim(K key, boolean approximateTrimming, long count)` Trims the stream to `count` elements.
`Executions<Long>`	`xtrim(K key, long count)` Trims the stream to `count` elements.

- Method Detail
  - xack
```
Executions<Long> xack(K key,
                      K group,
                      String... messageIds)
```
    Acknowledge one or more messages as processed.
    
    Parameters:
    
    key - the stream key.
    
    group - name of the consumer group.
    
    messageIds - message Id's to acknowledge.
    
    Returns:
    
    simple-reply the lenght of acknowledged messages.
  - xadd
```
Executions<String> xadd(K key,
                        Map<K,V> body)
```
    Append a message to the stream key.
    
    Parameters:
    
    key - the stream key.
    
    body - message body.
    
    Returns:
    
    simple-reply the message Id.
  - xadd
```
Executions<String> xadd(K key,
                        XAddArgs args,
                        Map<K,V> body)
```
    Append a message to the stream key.
    
    Parameters:
    
    key - the stream key.
    
    args -
    
    body - message body.
    
    Returns:
    
    simple-reply the message Id.
  - xadd
```
Executions<String> xadd(K key,
                        Object... keysAndValues)
```
    Append a message to the stream key.
    
    Parameters:
    
    key - the stream key.
    
    keysAndValues - message body.
    
    Returns:
    
    simple-reply the message Id.
  - xadd
```
Executions<String> xadd(K key,
                        XAddArgs args,
                        Object... keysAndValues)
```
    Append a message to the stream key.
    
    Parameters:
    
    key - the stream key.
    
    args -
    
    keysAndValues - message body.
    
    Returns:
    
    simple-reply the message Id.
  - xclaim
```
Executions<List<StreamMessage<K,V>>> xclaim(K key,
                                            Consumer<K> consumer,
                                            long minIdleTime,
                                            String... messageIds)
```
    Gets ownership of one or multiple messages in the Pending Entries List of a given stream consumer group.
    
    Parameters:
    
    key - the stream key.
    
    consumer - consumer identified by group name and consumer key.
    
    minIdleTime -
    
    messageIds - message Id's to claim.
    
    Returns:
    
    simple-reply the StreamMessage
  - xclaim
```
Executions<List<StreamMessage<K,V>>> xclaim(K key,
                                            Consumer<K> consumer,
                                            XClaimArgs args,
                                            String... messageIds)
```
    Gets ownership of one or multiple messages in the Pending Entries List of a given stream consumer group.
    
    Parameters:
    
    key - the stream key.
    
    consumer - consumer identified by group name and consumer key.
    
    args -
    
    messageIds - message Id's to claim.
    
    Returns:
    
    simple-reply the StreamMessage
  - xdel
```
Executions<Long> xdel(K key,
                      String... messageIds)
```
    Removes the specified entries from the stream. Returns the number of items deleted, that may be different from the number of IDs passed in case certain IDs do not exist.
    
    Parameters:
    
    key - the stream key.
    
    messageIds - stream message Id's.
    
    Returns:
    
    simple-reply number of removed entries.
  - xgroupCreate
```
Executions<String> xgroupCreate(XReadArgs.StreamOffset<K> streamOffset,
                                K group)
```
    Create a consumer group.
    
    Parameters:
    
    streamOffset - name of the stream containing the offset to set.
    
    group - name of the consumer group.
    
    Returns:
    
    simple-reply true if successful.
  - xgroupCreate
```
Executions<String> xgroupCreate(XReadArgs.StreamOffset<K> streamOffset,
                                K group,
                                XGroupCreateArgs args)
```
    Create a consumer group.
    
    Parameters:
    
    streamOffset - name of the stream containing the offset to set.
    
    group - name of the consumer group.
    
    args -
    
    Returns:
    
    simple-reply true if successful.
    
    Since:
    
    5.2
  - xgroupDelconsumer
```
Executions<Boolean> xgroupDelconsumer(K key,
                                      Consumer<K> consumer)
```
    Delete a consumer from a consumer group.
    
    Parameters:
    
    key - the stream key.
    
    consumer - consumer identified by group name and consumer key.
    
    Returns:
    
    simple-reply true if successful.
  - xgroupDestroy
```
Executions<Boolean> xgroupDestroy(K key,
                                  K group)
```
    Destroy a consumer group.
    
    Parameters:
    
    key - the stream key.
    
    group - name of the consumer group.
    
    Returns:
    
    simple-reply true if successful.
  - xgroupSetid
```
Executions<String> xgroupSetid(XReadArgs.StreamOffset<K> streamOffset,
                               K group)
```
    Set the current group id.
    
    Parameters:
    
    streamOffset - name of the stream containing the offset to set.
    
    group - name of the consumer group.
    
    Returns:
    
    simple-reply OK
  - xinfoStream
```
Executions<List<Object>> xinfoStream(K key)
```
    Retrieve information about the stream at key.
    
    Parameters:
    
    key - the stream key.
    
    Returns:
    
    List<Object> array-reply.
    
    Since:
    
    5.2
  - xinfoGroups
```
Executions<List<Object>> xinfoGroups(K key)
```
    Retrieve information about the stream consumer groups at key.
    
    Parameters:
    
    key - the stream key.
    
    Returns:
    
    List<Object> array-reply.
    
    Since:
    
    5.2
  - xinfoConsumers
```
Executions<List<Object>> xinfoConsumers(K key,
                                        K group)
```
    Retrieve information about consumer groups of group group and stream at key.
    
    Parameters:
    
    key - the stream key.
    
    group - name of the consumer group.
    
    Returns:
    
    List<Object> array-reply.
    
    Since:
    
    5.2
  - xlen
```
Executions<Long> xlen(K key)
```
    Get the length of a steam.
    
    Parameters:
    
    key - the stream key.
    
    Returns:
    
    simple-reply the lenght of the stream.
  - xpending
```
Executions<List<Object>> xpending(K key,
                                  K group)
```
    Read pending messages from a stream for a group.
    
    Parameters:
    
    key - the stream key.
    
    group - name of the consumer group.
    
    Returns:
    
    List<Object> array-reply list pending entries.
  - xpending
```
Executions<List<Object>> xpending(K key,
                                  K group,
                                  Range<String> range,
                                  Limit limit)
```
    Read pending messages from a stream within a specific Range.
    
    Parameters:
    
    key - the stream key.
    
    group - name of the consumer group.
    
    range - must not be null.
    
    limit - must not be null.
    
    Returns:
    
    List<Object> array-reply list with members of the resulting stream.
  - xpending
```
Executions<List<Object>> xpending(K key,
                                  Consumer<K> consumer,
                                  Range<String> range,
                                  Limit limit)
```
    Read pending messages from a stream within a specific Range.
    
    Parameters:
    
    key - the stream key.
    
    consumer - consumer identified by group name and consumer key.
    
    range - must not be null.
    
    limit - must not be null.
    
    Returns:
    
    List<Object> array-reply list with members of the resulting stream.
  - xrange
```
Executions<List<StreamMessage<K,V>>> xrange(K key,
                                            Range<String> range)
```
    Read messages from a stream within a specific Range.
    
    Parameters:
    
    key - the stream key.
    
    range - must not be null.
    
    Returns:
    
    List<StreamMessage> array-reply list with members of the resulting stream.
  - xrange
```
Executions<List<StreamMessage<K,V>>> xrange(K key,
                                            Range<String> range,
                                            Limit limit)
```
    Read messages from a stream within a specific Range applying a Limit.
    
    Parameters:
    
    key - the stream key.
    
    range - must not be null.
    
    limit - must not be null.
    
    Returns:
    
    List<StreamMessage> array-reply list with members of the resulting stream.
  - xread
```
Executions<List<StreamMessage<K,V>>> xread(XReadArgs.StreamOffset<K>... streams)
```
    Read messages from one or more XReadArgs.StreamOffsets.
    
    Parameters:
    
    streams - the streams to read from.
    
    Returns:
    
    List<StreamMessage> array-reply list with members of the resulting stream.
  - xread
```
Executions<List<StreamMessage<K,V>>> xread(XReadArgs args,
                                           XReadArgs.StreamOffset<K>... streams)
```
    Read messages from one or more XReadArgs.StreamOffsets.
    
    Parameters:
    
    args - read arguments.
    
    streams - the streams to read from.
    
    Returns:
    
    List<StreamMessage> array-reply list with members of the resulting stream.
  - xreadgroup
```
Executions<List<StreamMessage<K,V>>> xreadgroup(Consumer<K> consumer,
                                                XReadArgs.StreamOffset<K>... streams)
```
    Read messages from one or more XReadArgs.StreamOffsets using a consumer group.
    
    Parameters:
    
    consumer - consumer/group.
    
    streams - the streams to read from.
    
    Returns:
    
    List<StreamMessage> array-reply list with members of the resulting stream.
  - xreadgroup
```
Executions<List<StreamMessage<K,V>>> xreadgroup(Consumer<K> consumer,
                                                XReadArgs args,
                                                XReadArgs.StreamOffset<K>... streams)
```
    Read messages from one or more XReadArgs.StreamOffsets using a consumer group.
    
    Parameters:
    
    consumer - consumer/group.
    
    args - read arguments.
    
    streams - the streams to read from.
    
    Returns:
    
    List<StreamMessage> array-reply list with members of the resulting stream.
  - xrevrange
```
Executions<List<StreamMessage<K,V>>> xrevrange(K key,
                                               Range<String> range)
```
    Read messages from a stream within a specific Range in reverse order.
    
    Parameters:
    
    key - the stream key.
    
    range - must not be null.
    
    Returns:
    
    List<StreamMessage> array-reply list with members of the resulting stream.
  - xrevrange
```
Executions<List<StreamMessage<K,V>>> xrevrange(K key,
                                               Range<String> range,
                                               Limit limit)
```
    Read messages from a stream within a specific Range applying a Limit in reverse order.
    
    Parameters:
    
    key - the stream key.
    
    range - must not be null.
    
    limit - must not be null.
    
    Returns:
    
    List<StreamMessage> array-reply list with members of the resulting stream.
  - xtrim
```
Executions<Long> xtrim(K key,
                       long count)
```
    Trims the stream to count elements.
    
    Parameters:
    
    key - the stream key.
    
    count - length of the stream.
    
    Returns:
    
    simple-reply number of removed entries.
  - xtrim
```
Executions<Long> xtrim(K key,
                       boolean approximateTrimming,
                       long count)
```
    Trims the stream to count elements.
    
    Parameters:
    
    key - the stream key.
    
    approximateTrimming - true to trim approximately using the ~ flag.
    
    count - length of the stream.
    
    Returns:
    
    simple-reply number of removed entries.

Interface NodeSelectionStreamCommands<K,V>

Method Summary

Method Detail

xack

xadd

xadd

xadd

xadd

xclaim

xclaim

xdel

xgroupCreate

xgroupCreate

xgroupDelconsumer

xgroupDestroy

xgroupSetid

xinfoStream

xinfoGroups

xinfoConsumers

xlen

xpending

xpending

xpending

xrange

xrange

xread

xread

xreadgroup

xreadgroup

xrevrange

xrevrange

xtrim

xtrim