Package org.redisson.api

Interface RStream<K,V>

Type Parameters:

K - key type

V - value type

All Superinterfaces:

RExpirable, RExpirableAsync, RObject, RObjectAsync, RStreamAsync<K,V>

All Known Implementing Classes:

RedissonStream

public interface RStream<K,V>
extends RStreamAsync<K,V>, RExpirable

Interface for Redis Stream object.

Requires Redis 5.0.0 and higher.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
long	ack(String groupName, StreamMessageId... ids)	Marks pending messages by group name and stream ids as correctly processed.
StreamMessageId	add(K key, V value)	Deprecated.
StreamMessageId	add(K key, V value, int trimLen, boolean trimStrict)	Deprecated.
StreamMessageId	add(StreamAddArgs<K,V> args)	Appends a new entry/entries and returns generated Stream Message ID
void	add(StreamMessageId id, K key, V value)	Deprecated.
void	add(StreamMessageId id, K key, V value, int trimLen, boolean trimStrict)	Deprecated.
void	add(StreamMessageId id, StreamAddArgs<K,V> args)	Appends a new entry/entries by specified Stream Message ID
StreamMessageId	addAll(Map<K,V> entries)	Deprecated.
StreamMessageId	addAll(Map<K,V> entries, int trimLen, boolean trimStrict)	Deprecated.
void	addAll(StreamMessageId id, Map<K,V> entries)	Deprecated.
void	addAll(StreamMessageId id, Map<K,V> entries, int trimLen, boolean trimStrict)	Deprecated.
AutoClaimResult<K,V>	autoClaim(String groupName, String consumerName, long idleTime, TimeUnit idleTimeUnit, StreamMessageId startId, int count)	Transfers ownership of pending messages by id to a new consumer by name if idle time of messages and startId are greater than defined value.
Map<StreamMessageId,Map<K,V>>	claim(String groupName, String consumerName, long idleTime, TimeUnit idleTimeUnit, StreamMessageId... ids)	Transfers ownership of pending messages by id to a new consumer by name if idle time of messages is greater than defined value.
void	createConsumer(String groupName, String consumerName)	Creates consumer of the group by name.
void	createGroup(String groupName)	Creates consumer group by name.
void	createGroup(String groupName, StreamMessageId id)	Creates consumer group by name and Stream Message ID.
FastAutoClaimResult	fastAutoClaim(String groupName, String consumerName, long idleTime, TimeUnit idleTimeUnit, StreamMessageId startId, int count)	Transfers ownership of pending messages by id to a new consumer by name if idle time of messages and startId are greater than defined value.
List<StreamMessageId>	fastClaim(String groupName, String consumerName, long idleTime, TimeUnit idleTimeUnit, StreamMessageId... ids)	Transfers ownership of pending messages by id to a new consumer by name if idle time of messages is greater than defined value.
StreamInfo<K,V>	getInfo()	Returns information about this stream.
PendingResult	getPendingInfo(String groupName)	Returns common info about pending messages by group name.
List<StreamConsumer>	listConsumers(String groupName)	Returns list of common info about group customers for specified groupName.
List<StreamGroup>	listGroups()	Returns list of common info about groups belonging to this stream.
List<PendingEntry>	listPending(String groupName, String consumerName, StreamMessageId startId, StreamMessageId endId, int count)	Returns list of common info about pending messages by group and consumer name.
List<PendingEntry>	listPending(String groupName, String consumerName, StreamMessageId startId, StreamMessageId endId, long idleTime, TimeUnit idleTimeUnit, int count)	Returns stream data of pending messages by group and customer name.
List<PendingEntry>	listPending(String groupName, StreamMessageId startId, StreamMessageId endId, int count)	Returns list of common info about pending messages by group name.
List<PendingEntry>	listPending(String groupName, StreamMessageId startId, StreamMessageId endId, long idleTime, TimeUnit idleTimeUnit, int count)	Returns stream data of pending messages by group name.
Map<StreamMessageId,Map<K,V>>	pendingRange(String groupName, String consumerName, StreamMessageId startId, StreamMessageId endId, int count)	Returns stream data of pending messages by group and customer name.
Map<StreamMessageId,Map<K,V>>	pendingRange(String groupName, String consumerName, StreamMessageId startId, StreamMessageId endId, long idleTime, TimeUnit idleTimeUnit, int count)	Returns stream data of pending messages by group and customer name.
Map<StreamMessageId,Map<K,V>>	pendingRange(String groupName, StreamMessageId startId, StreamMessageId endId, int count)	Returns stream data of pending messages by group name.
Map<StreamMessageId,Map<K,V>>	pendingRange(String groupName, StreamMessageId startId, StreamMessageId endId, long idleTime, TimeUnit idleTimeUnit, int count)	Returns stream data of pending messages by group name.
Map<StreamMessageId,Map<K,V>>	range(int count, StreamMessageId startId, StreamMessageId endId)	Returns stream data in range by specified start Stream Message ID (included) and end Stream Message ID (included).
Map<StreamMessageId,Map<K,V>>	range(StreamMessageId startId, StreamMessageId endId)	Returns stream data in range by specified start Stream Message ID (included) and end Stream Message ID (included).
Map<StreamMessageId,Map<K,V>>	rangeReversed(int count, StreamMessageId startId, StreamMessageId endId)	Returns stream data in reverse order in range by specified start Stream Message ID (included) and end Stream Message ID (included).
Map<StreamMessageId,Map<K,V>>	rangeReversed(StreamMessageId startId, StreamMessageId endId)	Returns stream data in reverse order in range by specified start Stream Message ID (included) and end Stream Message ID (included).
Map<StreamMessageId,Map<K,V>>	read(int count, long timeout, TimeUnit unit, StreamMessageId... ids)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	read(int count, long timeout, TimeUnit unit, StreamMessageId id, String name2, StreamMessageId id2)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	read(int count, long timeout, TimeUnit unit, StreamMessageId id, String name2, StreamMessageId id2, String name3, StreamMessageId id3)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	read(int count, long timeout, TimeUnit unit, StreamMessageId id, Map<String,StreamMessageId> nameToId)	Deprecated.
Map<StreamMessageId,Map<K,V>>	read(int count, StreamMessageId... ids)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	read(int count, StreamMessageId id, String name2, StreamMessageId id2)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	read(int count, StreamMessageId id, String name2, StreamMessageId id2, String name3, StreamMessageId id3)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	read(int count, StreamMessageId id, Map<String,StreamMessageId> nameToId)	Deprecated.
Map<StreamMessageId,Map<K,V>>	read(long timeout, TimeUnit unit, StreamMessageId... ids)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	read(long timeout, TimeUnit unit, StreamMessageId id, String name2, StreamMessageId id2)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	read(long timeout, TimeUnit unit, StreamMessageId id, String name2, StreamMessageId id2, String name3, StreamMessageId id3)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	read(long timeout, TimeUnit unit, StreamMessageId id, Map<String,StreamMessageId> nameToId)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	read(StreamMultiReadArgs args)	Read stream data from multiple streams including current.
Map<StreamMessageId,Map<K,V>>	read(StreamReadArgs args)	Read stream data from current stream only.
Map<StreamMessageId,Map<K,V>>	read(StreamMessageId... ids)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	read(StreamMessageId id, String name2, StreamMessageId id2)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	read(StreamMessageId id, String name2, StreamMessageId id2, String name3, StreamMessageId id3)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	read(StreamMessageId id, Map<String,StreamMessageId> nameToId)	Deprecated.
Map<StreamMessageId,Map<K,V>>	readGroup(String groupName, String consumerName, int count, long timeout, TimeUnit unit, StreamMessageId... ids)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, int count, long timeout, TimeUnit unit, StreamMessageId id, String key2, StreamMessageId id2)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, int count, long timeout, TimeUnit unit, StreamMessageId id, String key2, StreamMessageId id2, String key3, StreamMessageId id3)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, int count, long timeout, TimeUnit unit, StreamMessageId id, Map<String,StreamMessageId> nameToId)	Deprecated.
Map<StreamMessageId,Map<K,V>>	readGroup(String groupName, String consumerName, int count, StreamMessageId... ids)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, int count, StreamMessageId id, String key2, StreamMessageId id2)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, int count, StreamMessageId id, String key2, StreamMessageId id2, String key3, StreamMessageId id3)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, int count, StreamMessageId id, Map<String,StreamMessageId> nameToId)	Deprecated.
Map<StreamMessageId,Map<K,V>>	readGroup(String groupName, String consumerName, long timeout, TimeUnit unit, StreamMessageId... ids)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, long timeout, TimeUnit unit, StreamMessageId id, String key2, StreamMessageId id2)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, long timeout, TimeUnit unit, StreamMessageId id, String key2, StreamMessageId id2, String key3, StreamMessageId id3)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, long timeout, TimeUnit unit, StreamMessageId id, Map<String,StreamMessageId> nameToId)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, StreamMultiReadGroupArgs args)	Read stream data from consumer group and multiple streams including current.
Map<StreamMessageId,Map<K,V>>	readGroup(String groupName, String consumerName, StreamReadGroupArgs args)	Read stream data from consumer group and current stream only.
Map<StreamMessageId,Map<K,V>>	readGroup(String groupName, String consumerName, StreamMessageId... ids)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, StreamMessageId id, String key2, StreamMessageId id2)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, StreamMessageId id, String key2, StreamMessageId id2, String key3, StreamMessageId id3)	Deprecated.
Map<String,Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, StreamMessageId id, Map<String,StreamMessageId> nameToId)	Deprecated.
long	remove(StreamMessageId... ids)	Removes messages by id.
long	removeConsumer(String groupName, String consumerName)	Removes consumer of the group by name.
void	removeGroup(String groupName)	Removes group by name.
long	size()	Returns number of entries in stream
long	trim(int size)	Deprecated.
long	trim(StreamTrimArgs args)	Trims stream using strict trimming.
long	trim(TrimStrategy strategy, int threshold)	Deprecated.
long	trimNonStrict(int size)	Deprecated.
long	trimNonStrict(StreamTrimArgs args)	Trims stream using non-strict trimming.
long	trimNonStrict(TrimStrategy strategy, int threshold)	Deprecated.
long	trimNonStrict(TrimStrategy strategy, int threshold, int limit)	Deprecated.
void	updateGroupMessageId(String groupName, StreamMessageId id)	Updates next message id delivered to consumers.

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObject

addListener, copy, delete, dump, getCodec, getIdleTime, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink

Methods inherited from interface org.redisson.api.RObjectAsync

addListenerAsync, copyAsync, deleteAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync

Methods inherited from interface org.redisson.api.RStreamAsync

ackAsync, addAllAsync, addAllAsync, addAllAsync, addAllAsync, addAsync, addAsync, addAsync, addAsync, addAsync, addAsync, autoClaimAsync, claimAsync, createConsumerAsync, createGroupAsync, createGroupAsync, fastAutoClaimAsync, fastClaimAsync, getInfoAsync, getPendingInfoAsync, listConsumersAsync, listGroupsAsync, listPendingAsync, listPendingAsync, listPendingAsync, listPendingAsync, pendingRangeAsync, pendingRangeAsync, pendingRangeAsync, pendingRangeAsync, rangeAsync, rangeAsync, rangeReversedAsync, rangeReversedAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readGroupAsync, readGroupAsync, readGroupAsync, readGroupAsync, readGroupAsync, readGroupAsync, readGroupAsync, readGroupAsync, readGroupAsync, readGroupAsync, readGroupAsync, readGroupAsync, readGroupAsync, readGroupAsync, readGroupAsync, readGroupAsync, readGroupAsync, removeAsync, removeConsumerAsync, removeGroupAsync, sizeAsync, trimAsync, trimAsync, trimAsync, trimNonStrictAsync, trimNonStrictAsync, trimNonStrictAsync, trimNonStrictAsync, updateGroupMessageIdAsync

Method Detail

createGroup

void createGroup(String groupName)

Creates consumer group by name. Only new messages will be available for consumers of this group.

Parameters:

groupName - - name of group

createGroup

void createGroup(String groupName,
                 StreamMessageId id)

Creates consumer group by name and Stream Message ID. Only new messages after defined stream id will be available for consumers of this group.

StreamMessageId.NEWEST is used for messages arrived since the moment of group creation StreamMessageId.ALL is used for all messages added before and after the moment of group creation

Parameters:

groupName - - name of group

id - - Stream Message ID

removeGroup

void removeGroup(String groupName)

Removes group by name.

Parameters:

groupName - - name of group

createConsumer

void createConsumer(String groupName,
                    String consumerName)

Creates consumer of the group by name.

Requires Redis 6.2.0 and higher.

Parameters:

groupName - - name of group

consumerName - - name of consumer

removeConsumer

long removeConsumer(String groupName,
                    String consumerName)

Removes consumer of the group by name.

Parameters:

groupName - - name of group

consumerName - - name of consumer

Returns:

number of pending messages owned by consumer

updateGroupMessageId

void updateGroupMessageId(String groupName,
                          StreamMessageId id)

Updates next message id delivered to consumers.

Parameters:

groupName - - name of group

id - - Stream Message ID

ack

long ack(String groupName,
         StreamMessageId... ids)

Marks pending messages by group name and stream ids as correctly processed.

Parameters:

groupName - - name of group

ids - - Stream Message IDs

Returns:

marked messages amount

getPendingInfo

PendingResult getPendingInfo(String groupName)

Returns common info about pending messages by group name.

Parameters:

groupName - - name of group

Returns:

result object

listPending

List<PendingEntry> listPending(String groupName,
                               StreamMessageId startId,
                               StreamMessageId endId,
                               int count)

Returns list of common info about pending messages by group name. Limited by start Stream Message ID and end Stream Message ID and count.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Parameters:

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

count - - amount of messages

Returns:

list

See Also:

RStreamAsync.pendingRangeAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, int)

listPending

List<PendingEntry> listPending(String groupName,
                               String consumerName,
                               StreamMessageId startId,
                               StreamMessageId endId,
                               int count)

Returns list of common info about pending messages by group and consumer name. Limited by start Stream Message ID and end Stream Message ID and count.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Parameters:

consumerName - - name of consumer

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

count - - amount of messages

Returns:

list

See Also:

RStreamAsync.pendingRangeAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, int)

listPending

List<PendingEntry> listPending(String groupName,
                               StreamMessageId startId,
                               StreamMessageId endId,
                               long idleTime,
                               TimeUnit idleTimeUnit,
                               int count)

Returns stream data of pending messages by group name. Limited by minimum idle time, messages count, start and end Stream Message IDs.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Requires Redis 6.2.0 and higher.

Parameters:

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

count - - amount of messages

Returns:

map

See Also:

RStreamAsync.listPendingAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, long, java.util.concurrent.TimeUnit, int)

listPending

List<PendingEntry> listPending(String groupName,
                               String consumerName,
                               StreamMessageId startId,
                               StreamMessageId endId,
                               long idleTime,
                               TimeUnit idleTimeUnit,
                               int count)

Returns stream data of pending messages by group and customer name. Limited by minimum idle time, messages count, start and end Stream Message IDs.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Requires Redis 6.2.0 and higher.

Parameters:

consumerName - - name of consumer

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

count - - amount of messages

Returns:

map

See Also:

RStreamAsync.listPendingAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, long, java.util.concurrent.TimeUnit, int)

pendingRange

Map<StreamMessageId,Map<K,V>> pendingRange(String groupName,
                                                       StreamMessageId startId,
                                                       StreamMessageId endId,
                                                       int count)

Returns stream data of pending messages by group name. Limited by start Stream Message ID and end Stream Message ID and count.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Parameters:

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

count - - amount of messages

Returns:

map

See Also:

listPending(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, int)

pendingRange

Map<StreamMessageId,Map<K,V>> pendingRange(String groupName,
                                                       String consumerName,
                                                       StreamMessageId startId,
                                                       StreamMessageId endId,
                                                       int count)

Returns stream data of pending messages by group and customer name. Limited by start Stream Message ID and end Stream Message ID and count.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Parameters:

consumerName - - name of consumer

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

count - - amount of messages

Returns:

map

See Also:

listPending(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, int)

pendingRange

Map<StreamMessageId,Map<K,V>> pendingRange(String groupName,
                                                       StreamMessageId startId,
                                                       StreamMessageId endId,
                                                       long idleTime,
                                                       TimeUnit idleTimeUnit,
                                                       int count)

Returns stream data of pending messages by group name. Limited by minimum idle time, messages count, start and end Stream Message IDs.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Requires Redis 6.2.0 and higher.

Parameters:

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

count - - amount of messages

Returns:

map

See Also:

RStreamAsync.listPendingAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, long, java.util.concurrent.TimeUnit, int)

pendingRange

Map<StreamMessageId,Map<K,V>> pendingRange(String groupName,
                                                       String consumerName,
                                                       StreamMessageId startId,
                                                       StreamMessageId endId,
                                                       long idleTime,
                                                       TimeUnit idleTimeUnit,
                                                       int count)

Returns stream data of pending messages by group and customer name. Limited by minimum idle time, messages count, start and end Stream Message IDs.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Requires Redis 6.2.0 and higher.

Parameters:

consumerName - - name of consumer

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

count - - amount of messages

Returns:

map

See Also:

RStreamAsync.listPendingAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, long, java.util.concurrent.TimeUnit, int)

autoClaim

AutoClaimResult<K,V> autoClaim(String groupName,
                                     String consumerName,
                                     long idleTime,
                                     TimeUnit idleTimeUnit,
                                     StreamMessageId startId,
                                     int count)

Transfers ownership of pending messages by id to a new consumer by name if idle time of messages and startId are greater than defined value.

Parameters:

groupName - - name of group

consumerName - - name of consumer

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

startId - - start Stream Message ID

Returns:

stream data mapped by Stream ID

claim

Map<StreamMessageId,Map<K,V>> claim(String groupName,
                                                String consumerName,
                                                long idleTime,
                                                TimeUnit idleTimeUnit,
                                                StreamMessageId... ids)

Transfers ownership of pending messages by id to a new consumer by name if idle time of messages is greater than defined value.

Parameters:

groupName - - name of group

consumerName - - name of consumer

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

ids - - Stream Message IDs

Returns:

stream data mapped by Stream Message ID

fastClaim

List<StreamMessageId> fastClaim(String groupName,
                                String consumerName,
                                long idleTime,
                                TimeUnit idleTimeUnit,
                                StreamMessageId... ids)

Transfers ownership of pending messages by id to a new consumer by name if idle time of messages is greater than defined value.

Parameters:

groupName - - name of group

consumerName - - name of consumer

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

ids - - Stream Message IDs

Returns:

list of Stream Message IDs

fastAutoClaim

FastAutoClaimResult fastAutoClaim(String groupName,
                                  String consumerName,
                                  long idleTime,
                                  TimeUnit idleTimeUnit,
                                  StreamMessageId startId,
                                  int count)

Transfers ownership of pending messages by id to a new consumer by name if idle time of messages and startId are greater than defined value.

Parameters:

groupName - - name of group

consumerName - - name of consumer

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

startId - - start Stream Message ID

Returns:

list of Stream Message IDs

readGroup

Map<String,Map<StreamMessageId,Map<K,V>>> readGroup(String groupName,
                                                                      String consumerName,
                                                                      StreamMultiReadGroupArgs args)

Read stream data from consumer group and multiple streams including current.

Usage examples:

 Map result = stream.read("group1", "consumer1",  StreamMultiReadGroupArgs.greaterThan(id, "stream2", id2));
 

 Map result = stream.read("group1", "consumer1", StreamMultiReadGroupArgs.greaterThan(id, "stream2", id2)
                                                                          .count(100)
                                                                          .timeout(Duration.ofSeconds(5))));
 

Parameters:

args - - method arguments object

Returns:

stream data mapped by stream name and Stream Message ID

readGroup

Map<StreamMessageId,Map<K,V>> readGroup(String groupName,
                                                    String consumerName,
                                                    StreamReadGroupArgs args)

Read stream data from consumer group and current stream only.

Usage examples:

 Map result = stream.read("group1", "consumer1",  StreamReadGroupArgs.greaterThan(id));
 

 Map result = stream.read("group1", "consumer1", StreamReadGroupArgs.greaterThan(id)
                                                                          .count(100)
                                                                          .timeout(Duration.ofSeconds(5))));
 

Parameters:

args - - method arguments object

Returns:

stream data mapped by Stream Message ID

readGroup

@Deprecated
Map<StreamMessageId,Map<K,V>> readGroup(String groupName,
                                                    String consumerName,
                                                    StreamMessageId... ids)

Deprecated.

readGroup

@Deprecated
Map<StreamMessageId,Map<K,V>> readGroup(String groupName,
                                                    String consumerName,
                                                    int count,
                                                    StreamMessageId... ids)

Deprecated.

readGroup

@Deprecated
Map<StreamMessageId,Map<K,V>> readGroup(String groupName,
                                                    String consumerName,
                                                    long timeout,
                                                    TimeUnit unit,
                                                    StreamMessageId... ids)

Deprecated.

readGroup

@Deprecated
Map<StreamMessageId,Map<K,V>> readGroup(String groupName,
                                                    String consumerName,
                                                    int count,
                                                    long timeout,
                                                    TimeUnit unit,
                                                    StreamMessageId... ids)

Deprecated.

readGroup

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> readGroup(String groupName,
                                                                      String consumerName,
                                                                      StreamMessageId id,
                                                                      Map<String,StreamMessageId> nameToId)

Deprecated.

readGroup

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> readGroup(String groupName,
                                                                      String consumerName,
                                                                      int count,
                                                                      StreamMessageId id,
                                                                      Map<String,StreamMessageId> nameToId)

Deprecated.

readGroup

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> readGroup(String groupName,
                                                                      String consumerName,
                                                                      int count,
                                                                      long timeout,
                                                                      TimeUnit unit,
                                                                      StreamMessageId id,
                                                                      Map<String,StreamMessageId> nameToId)

Deprecated.

readGroup

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> readGroup(String groupName,
                                                                      String consumerName,
                                                                      long timeout,
                                                                      TimeUnit unit,
                                                                      StreamMessageId id,
                                                                      Map<String,StreamMessageId> nameToId)

Deprecated.

readGroup

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> readGroup(String groupName,
                                                                      String consumerName,
                                                                      StreamMessageId id,
                                                                      String key2,
                                                                      StreamMessageId id2)

Deprecated.

readGroup

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> readGroup(String groupName,
                                                                      String consumerName,
                                                                      StreamMessageId id,
                                                                      String key2,
                                                                      StreamMessageId id2,
                                                                      String key3,
                                                                      StreamMessageId id3)

Deprecated.

readGroup

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> readGroup(String groupName,
                                                                      String consumerName,
                                                                      int count,
                                                                      StreamMessageId id,
                                                                      String key2,
                                                                      StreamMessageId id2)

Deprecated.

readGroup

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> readGroup(String groupName,
                                                                      String consumerName,
                                                                      int count,
                                                                      StreamMessageId id,
                                                                      String key2,
                                                                      StreamMessageId id2,
                                                                      String key3,
                                                                      StreamMessageId id3)

Deprecated.

readGroup

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> readGroup(String groupName,
                                                                      String consumerName,
                                                                      long timeout,
                                                                      TimeUnit unit,
                                                                      StreamMessageId id,
                                                                      String key2,
                                                                      StreamMessageId id2)

Deprecated.

readGroup

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> readGroup(String groupName,
                                                                      String consumerName,
                                                                      long timeout,
                                                                      TimeUnit unit,
                                                                      StreamMessageId id,
                                                                      String key2,
                                                                      StreamMessageId id2,
                                                                      String key3,
                                                                      StreamMessageId id3)

Deprecated.

readGroup

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> readGroup(String groupName,
                                                                      String consumerName,
                                                                      int count,
                                                                      long timeout,
                                                                      TimeUnit unit,
                                                                      StreamMessageId id,
                                                                      String key2,
                                                                      StreamMessageId id2)

Deprecated.

readGroup

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> readGroup(String groupName,
                                                                      String consumerName,
                                                                      int count,
                                                                      long timeout,
                                                                      TimeUnit unit,
                                                                      StreamMessageId id,
                                                                      String key2,
                                                                      StreamMessageId id2,
                                                                      String key3,
                                                                      StreamMessageId id3)

Deprecated.

size

long size()

Returns number of entries in stream

Returns:

size of stream

add

StreamMessageId add(StreamAddArgs<K,V> args)

Appends a new entry/entries and returns generated Stream Message ID

Usage examples:

 StreamMessageId id = stream.add(StreamAddArgs.entry(15, 37));
 

 StreamMessageId id = stream.add(StreamAddArgs.entries(15, 37, 23, 43)
                                 .trim(TrimStrategy.MAXLEN, 100)));
 

Parameters:

args - - method arguments object

Returns:

Stream Message ID

add

void add(StreamMessageId id,
         StreamAddArgs<K,V> args)

Appends a new entry/entries by specified Stream Message ID

Usage examples:

 stream.add(id, StreamAddArgs.entry(15, 37));
 

 stream.add(id, StreamAddArgs.entries(15, 37, 23, 43)
                                 .trim(TrimStrategy.MAXLEN, 100)));
 

Parameters:

id - - Stream Message ID

args - - method arguments object

add

@Deprecated
StreamMessageId add(K key,
                    V value)

Deprecated.

add

@Deprecated
void add(StreamMessageId id,
         K key,
         V value)

Deprecated.

add

@Deprecated
StreamMessageId add(K key,
                    V value,
                    int trimLen,
                    boolean trimStrict)

Deprecated.

add

@Deprecated
void add(StreamMessageId id,
         K key,
         V value,
         int trimLen,
         boolean trimStrict)

Deprecated.

addAll

@Deprecated
StreamMessageId addAll(Map<K,V> entries)

Deprecated.

addAll

@Deprecated
void addAll(StreamMessageId id,
            Map<K,V> entries)

Deprecated.

addAll

@Deprecated
StreamMessageId addAll(Map<K,V> entries,
                       int trimLen,
                       boolean trimStrict)

Deprecated.

addAll

@Deprecated
void addAll(StreamMessageId id,
            Map<K,V> entries,
            int trimLen,
            boolean trimStrict)

Deprecated.

read

Map<String,Map<StreamMessageId,Map<K,V>>> read(StreamMultiReadArgs args)

Read stream data from multiple streams including current.

Usage examples:

 Map result = stream.read(StreamMultiReadArgs.greaterThan(id, "stream2", id2));
 

 Map result = stream.read(StreamMultiReadArgs.greaterThan(id, "stream2", id2)
                                 .count(100)
                                 .timeout(Duration.ofSeconds(5))));
 

Parameters:

args - - method arguments object

Returns:

stream data mapped by stream name and Stream Message ID

read

Map<StreamMessageId,Map<K,V>> read(StreamReadArgs args)

Read stream data from current stream only.

Usage examples:

 Map result = stream.read(StreamReadArgs.greaterThan(id));
 

 Map result = stream.read(StreamReadArgs.greaterThan(id)
                                 .count(100)
                                 .timeout(Duration.ofSeconds(5))));
 

Parameters:

args - - method arguments object

Returns:

stream data mapped by Stream Message ID

read

@Deprecated
Map<StreamMessageId,Map<K,V>> read(StreamMessageId... ids)

Deprecated.

read

@Deprecated
Map<StreamMessageId,Map<K,V>> read(int count,
                                               StreamMessageId... ids)

Deprecated.

read

@Deprecated
Map<StreamMessageId,Map<K,V>> read(long timeout,
                                               TimeUnit unit,
                                               StreamMessageId... ids)

Deprecated.

read

@Deprecated
Map<StreamMessageId,Map<K,V>> read(int count,
                                               long timeout,
                                               TimeUnit unit,
                                               StreamMessageId... ids)

Deprecated.

read

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> read(StreamMessageId id,
                                                                 String name2,
                                                                 StreamMessageId id2)

Deprecated.

read

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> read(StreamMessageId id,
                                                                 String name2,
                                                                 StreamMessageId id2,
                                                                 String name3,
                                                                 StreamMessageId id3)

Deprecated.

read

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> read(StreamMessageId id,
                                                                 Map<String,StreamMessageId> nameToId)

Deprecated.

read

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> read(int count,
                                                                 StreamMessageId id,
                                                                 String name2,
                                                                 StreamMessageId id2)

Deprecated.

read

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> read(int count,
                                                                 StreamMessageId id,
                                                                 String name2,
                                                                 StreamMessageId id2,
                                                                 String name3,
                                                                 StreamMessageId id3)

Deprecated.

read

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> read(int count,
                                                                 StreamMessageId id,
                                                                 Map<String,StreamMessageId> nameToId)

Deprecated.

read

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> read(long timeout,
                                                                 TimeUnit unit,
                                                                 StreamMessageId id,
                                                                 String name2,
                                                                 StreamMessageId id2)

Deprecated.

read

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> read(long timeout,
                                                                 TimeUnit unit,
                                                                 StreamMessageId id,
                                                                 String name2,
                                                                 StreamMessageId id2,
                                                                 String name3,
                                                                 StreamMessageId id3)

Deprecated.

read

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> read(long timeout,
                                                                 TimeUnit unit,
                                                                 StreamMessageId id,
                                                                 Map<String,StreamMessageId> nameToId)

Deprecated.

read

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> read(int count,
                                                                 long timeout,
                                                                 TimeUnit unit,
                                                                 StreamMessageId id,
                                                                 String name2,
                                                                 StreamMessageId id2)

Deprecated.

read

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> read(int count,
                                                                 long timeout,
                                                                 TimeUnit unit,
                                                                 StreamMessageId id,
                                                                 String name2,
                                                                 StreamMessageId id2,
                                                                 String name3,
                                                                 StreamMessageId id3)

Deprecated.

read

@Deprecated
Map<String,Map<StreamMessageId,Map<K,V>>> read(int count,
                                                                 long timeout,
                                                                 TimeUnit unit,
                                                                 StreamMessageId id,
                                                                 Map<String,StreamMessageId> nameToId)

Deprecated.

range

Map<StreamMessageId,Map<K,V>> range(StreamMessageId startId,
                                                StreamMessageId endId)

Returns stream data in range by specified start Stream Message ID (included) and end Stream Message ID (included).

Parameters:

startId - - start Stream Message ID

endId - - end Stream Message ID

Returns:

stream data mapped by Stream Message ID

range

Map<StreamMessageId,Map<K,V>> range(int count,
                                                StreamMessageId startId,
                                                StreamMessageId endId)

Returns stream data in range by specified start Stream Message ID (included) and end Stream Message ID (included).

Parameters:

count - - stream data size limit

startId - - start Stream Message ID

endId - - end Stream Message ID

Returns:

stream data mapped by Stream Message ID

rangeReversed

Map<StreamMessageId,Map<K,V>> rangeReversed(StreamMessageId startId,
                                                        StreamMessageId endId)

Returns stream data in reverse order in range by specified start Stream Message ID (included) and end Stream Message ID (included).

Parameters:

startId - - start Stream Message ID

endId - - end Stream Message ID

Returns:

stream data mapped by Stream Message ID

rangeReversed

Map<StreamMessageId,Map<K,V>> rangeReversed(int count,
                                                        StreamMessageId startId,
                                                        StreamMessageId endId)

Returns stream data in reverse order in range by specified start Stream Message ID (included) and end Stream Message ID (included).

Parameters:

count - - stream data size limit

startId - - start Stream Message ID

endId - - end Stream Message ID

Returns:

stream data mapped by Stream Message ID

remove

long remove(StreamMessageId... ids)

Removes messages by id.

Parameters:

ids - - id of messages to remove

Returns:

deleted messages amount

trim

long trim(StreamTrimArgs args)

Trims stream using strict trimming.

Parameters:

args - - method arguments object

Returns:

number of deleted messages

trimNonStrict

long trimNonStrict(StreamTrimArgs args)

Trims stream using non-strict trimming.

Parameters:

args - - method arguments object

Returns:

number of deleted messages

trim

@Deprecated
long trim(int size)

Deprecated.

trim

@Deprecated
long trim(TrimStrategy strategy,
          int threshold)

Deprecated.

trimNonStrict

@Deprecated
long trimNonStrict(int size)

Deprecated.

trimNonStrict

@Deprecated
long trimNonStrict(TrimStrategy strategy,
                   int threshold)

Deprecated.

trimNonStrict

@Deprecated
long trimNonStrict(TrimStrategy strategy,
                   int threshold,
                   int limit)

Deprecated.

Trims stream using almost exact trimming threshold up to limit.

Parameters:

strategy - - trim strategy

threshold - - trim threshold

limit - - trim limit

Returns:

number of deleted messages

getInfo

StreamInfo<K,V> getInfo()

Returns information about this stream.

Returns:

info object

listGroups

List<StreamGroup> listGroups()

Returns list of common info about groups belonging to this stream.

Returns:

list of info objects

listConsumers

List<StreamConsumer> listConsumers(String groupName)

Returns list of common info about group customers for specified groupName.

Parameters:

groupName - - name of group

Returns:

list of info objects