redis.clients.jedis.commands

Interface StreamBinaryCommands

All Known Subinterfaces:

JedisBinaryCommands

All Known Implementing Classes:

Jedis, JedisCluster, JedisPooled, JedisSentineled, MultiDbClient, UnifiedJedis

public interface StreamBinaryCommands

Method Summary

Modifier and Type	Method and Description
long	xack(byte[] key, byte[] group, byte[]... ids)
java.util.List<StreamEntryDeletionResult>	xackdel(byte[] key, byte[] group, byte[]... ids) XACKDEL key group [KEEPREF | DELREF | ACKED] IDS numids id [id ...]
java.util.List<StreamEntryDeletionResult>	xackdel(byte[] key, byte[] group, StreamDeletionPolicy trimMode, byte[]... ids) XACKDEL key group [KEEPREF | DELREF | ACKED] IDS numids id [id ...]
default byte[]	xadd(byte[] key, java.util.Map<byte[],byte[]> hash, XAddParams params)
byte[]	xadd(byte[] key, XAddParams params, java.util.Map<byte[],byte[]> hash)
java.util.List<java.lang.Object>	xautoclaim(byte[] key, byte[] groupName, byte[] consumerName, long minIdleTime, byte[] start, XAutoClaimParams params)
java.util.List<java.lang.Object>	xautoclaimJustId(byte[] key, byte[] groupName, byte[] consumerName, long minIdleTime, byte[] start, XAutoClaimParams params)
java.util.List<byte[]>	xclaim(byte[] key, byte[] group, byte[] consumerName, long minIdleTime, XClaimParams params, byte[]... ids)
java.util.List<byte[]>	xclaimJustId(byte[] key, byte[] group, byte[] consumerName, long minIdleTime, XClaimParams params, byte[]... ids)
long	xdel(byte[] key, byte[]... ids)
java.util.List<StreamEntryDeletionResult>	xdelex(byte[] key, byte[]... ids) XDELEX key [KEEPREF | DELREF | ACKED] IDS numids id [id ...]
java.util.List<StreamEntryDeletionResult>	xdelex(byte[] key, StreamDeletionPolicy trimMode, byte[]... ids) XDELEX key [KEEPREF | DELREF | ACKED] IDS numids id [id ...]
java.lang.String	xgroupCreate(byte[] key, byte[] groupName, byte[] id, boolean makeStream)
boolean	xgroupCreateConsumer(byte[] key, byte[] groupName, byte[] consumerName)
long	xgroupDelConsumer(byte[] key, byte[] groupName, byte[] consumerName)
long	xgroupDestroy(byte[] key, byte[] groupName)
java.lang.String	xgroupSetID(byte[] key, byte[] groupName, byte[] id)
java.util.List<java.lang.Object>	xinfoConsumers(byte[] key, byte[] group)
java.util.List<java.lang.Object>	xinfoGroups(byte[] key)
java.lang.Object	xinfoStream(byte[] key)
java.lang.Object	xinfoStreamFull(byte[] key) Introspection command used in order to retrieve all information about the stream
java.lang.Object	xinfoStreamFull(byte[] key, int count) Introspection command used in order to retrieve all information about the stream
long	xlen(byte[] key)
java.lang.Object	xpending(byte[] key, byte[] groupName)
java.util.List<java.lang.Object>	xpending(byte[] key, byte[] groupName, XPendingParams params)
java.util.List<java.lang.Object>	xrange(byte[] key, byte[] start, byte[] end)
java.util.List<java.lang.Object>	xrange(byte[] key, byte[] start, byte[] end, int count)
java.util.List<java.lang.Object>	xread(XReadParams xReadParams, java.util.Map.Entry<byte[],byte[]>... streams) Deprecated. As of Jedis 6.1.0, replaced by xreadBinary(XReadParams, Map) or xreadBinaryAsMap(XReadParams, Map) for type safety and better stream entry parsing.
java.util.List<java.util.Map.Entry<byte[],java.util.List<StreamEntryBinary>>>	xreadBinary(XReadParams xReadParams, java.util.Map<byte[],StreamEntryID> streams) Read from one or more streams.
java.util.Map<byte[],java.util.List<StreamEntryBinary>>	xreadBinaryAsMap(XReadParams xReadParams, java.util.Map<byte[],StreamEntryID> streams) Read from one or more streams and return a map of stream name to list of entries.
java.util.List<java.lang.Object>	xreadGroup(byte[] groupName, byte[] consumer, XReadGroupParams xReadGroupParams, java.util.Map.Entry<byte[],byte[]>... streams) Deprecated. As of Jedis 6.1.0, use xreadGroupBinary(byte[], byte[], XReadGroupParams, Map) or xreadGroupBinaryAsMap(byte[], byte[], XReadGroupParams, Map) instead.
java.util.List<java.util.Map.Entry<byte[],java.util.List<StreamEntryBinary>>>	xreadGroupBinary(byte[] groupName, byte[] consumer, XReadGroupParams xReadGroupParams, java.util.Map<byte[],StreamEntryID> streams) Read from one or more streams as a consumer group.
java.util.Map<byte[],java.util.List<StreamEntryBinary>>	xreadGroupBinaryAsMap(byte[] groupName, byte[] consumer, XReadGroupParams xReadGroupParams, java.util.Map<byte[],StreamEntryID> streams) Read from one or more streams as a consumer group and return a map of stream name to list of entries.
java.util.List<java.lang.Object>	xrevrange(byte[] key, byte[] end, byte[] start)
java.util.List<java.lang.Object>	xrevrange(byte[] key, byte[] end, byte[] start, int count)
long	xtrim(byte[] key, long maxLen, boolean approximateLength)
long	xtrim(byte[] key, XTrimParams params)

Method Detail

xadd

default byte[] xadd(byte[] key,
                    java.util.Map<byte[],byte[]> hash,
                    XAddParams params)

xadd

byte[] xadd(byte[] key,
            XAddParams params,
            java.util.Map<byte[],byte[]> hash)

xlen

long xlen(byte[] key)

xrange

java.util.List<java.lang.Object> xrange(byte[] key,
                                        byte[] start,
                                        byte[] end)

xrange

java.util.List<java.lang.Object> xrange(byte[] key,
                                        byte[] start,
                                        byte[] end,
                                        int count)

xrevrange

java.util.List<java.lang.Object> xrevrange(byte[] key,
                                           byte[] end,
                                           byte[] start)

xrevrange

java.util.List<java.lang.Object> xrevrange(byte[] key,
                                           byte[] end,
                                           byte[] start,
                                           int count)

xack

long xack(byte[] key,
          byte[] group,
          byte[]... ids)

xackdel

java.util.List<StreamEntryDeletionResult> xackdel(byte[] key,
                                                  byte[] group,
                                                  byte[]... ids)

XACKDEL key group [KEEPREF | DELREF | ACKED] IDS numids id [id ...]

xackdel

java.util.List<StreamEntryDeletionResult> xackdel(byte[] key,
                                                  byte[] group,
                                                  StreamDeletionPolicy trimMode,
                                                  byte[]... ids)

XACKDEL key group [KEEPREF | DELREF | ACKED] IDS numids id [id ...]

xgroupCreate

java.lang.String xgroupCreate(byte[] key,
                              byte[] groupName,
                              byte[] id,
                              boolean makeStream)

xgroupSetID

java.lang.String xgroupSetID(byte[] key,
                             byte[] groupName,
                             byte[] id)

xgroupDestroy

long xgroupDestroy(byte[] key,
                   byte[] groupName)

xgroupCreateConsumer

boolean xgroupCreateConsumer(byte[] key,
                             byte[] groupName,
                             byte[] consumerName)

xgroupDelConsumer

long xgroupDelConsumer(byte[] key,
                       byte[] groupName,
                       byte[] consumerName)

xdel

long xdel(byte[] key,
          byte[]... ids)

xdelex

java.util.List<StreamEntryDeletionResult> xdelex(byte[] key,
                                                 byte[]... ids)

XDELEX key [KEEPREF | DELREF | ACKED] IDS numids id [id ...]

xdelex

java.util.List<StreamEntryDeletionResult> xdelex(byte[] key,
                                                 StreamDeletionPolicy trimMode,
                                                 byte[]... ids)

XDELEX key [KEEPREF | DELREF | ACKED] IDS numids id [id ...]

xtrim

long xtrim(byte[] key,
           long maxLen,
           boolean approximateLength)

xtrim

long xtrim(byte[] key,
           XTrimParams params)

xpending

java.lang.Object xpending(byte[] key,
                          byte[] groupName)

xpending

java.util.List<java.lang.Object> xpending(byte[] key,
                                          byte[] groupName,
                                          XPendingParams params)

xclaim

java.util.List<byte[]> xclaim(byte[] key,
                              byte[] group,
                              byte[] consumerName,
                              long minIdleTime,
                              XClaimParams params,
                              byte[]... ids)

xclaimJustId

java.util.List<byte[]> xclaimJustId(byte[] key,
                                    byte[] group,
                                    byte[] consumerName,
                                    long minIdleTime,
                                    XClaimParams params,
                                    byte[]... ids)

xautoclaim

java.util.List<java.lang.Object> xautoclaim(byte[] key,
                                            byte[] groupName,
                                            byte[] consumerName,
                                            long minIdleTime,
                                            byte[] start,
                                            XAutoClaimParams params)

xautoclaimJustId

java.util.List<java.lang.Object> xautoclaimJustId(byte[] key,
                                                  byte[] groupName,
                                                  byte[] consumerName,
                                                  long minIdleTime,
                                                  byte[] start,
                                                  XAutoClaimParams params)

xinfoStream

java.lang.Object xinfoStream(byte[] key)

xinfoStreamFull

java.lang.Object xinfoStreamFull(byte[] key)

Introspection command used in order to retrieve all information about the stream

Parameters:

key - Stream name

xinfoStreamFull

java.lang.Object xinfoStreamFull(byte[] key,
                                 int count)

Introspection command used in order to retrieve all information about the stream

Parameters:

key - Stream name

count - stream info count

xinfoGroups

java.util.List<java.lang.Object> xinfoGroups(byte[] key)

xinfoConsumers

java.util.List<java.lang.Object> xinfoConsumers(byte[] key,
                                                byte[] group)

xread

@Deprecated
java.util.List<java.lang.Object> xread(XReadParams xReadParams,
                                                   java.util.Map.Entry<byte[],byte[]>... streams)

Deprecated. As of Jedis 6.1.0, replaced by xreadBinary(XReadParams, Map) or xreadBinaryAsMap(XReadParams, Map) for type safety and better stream entry parsing.

xreadGroup

@Deprecated
java.util.List<java.lang.Object> xreadGroup(byte[] groupName,
                                                        byte[] consumer,
                                                        XReadGroupParams xReadGroupParams,
                                                        java.util.Map.Entry<byte[],byte[]>... streams)

Deprecated. As of Jedis 6.1.0, use xreadGroupBinary(byte[], byte[], XReadGroupParams, Map) or xreadGroupBinaryAsMap(byte[], byte[], XReadGroupParams, Map) instead.

xreadBinary

java.util.List<java.util.Map.Entry<byte[],java.util.List<StreamEntryBinary>>> xreadBinary(XReadParams xReadParams,
                                                                                          java.util.Map<byte[],StreamEntryID> streams)

Read from one or more streams.

Parameters:

xReadParams - XReadParams

streams - Map of stream name and ID to read from.

Returns:

List of entries. Each entry in the list is a pair of stream name and the entries reported for that key.

xreadBinaryAsMap

java.util.Map<byte[],java.util.List<StreamEntryBinary>> xreadBinaryAsMap(XReadParams xReadParams,
                                                                         java.util.Map<byte[],StreamEntryID> streams)

Read from one or more streams and return a map of stream name to list of entries.

Parameters:

xReadParams - XReadParams

streams - Map of stream name and ID to read from.

Returns:

Map of stream name to list of entries. key is the stream name and value is the list of entries reported for that key.

xreadGroupBinary

java.util.List<java.util.Map.Entry<byte[],java.util.List<StreamEntryBinary>>> xreadGroupBinary(byte[] groupName,
                                                                                               byte[] consumer,
                                                                                               XReadGroupParams xReadGroupParams,
                                                                                               java.util.Map<byte[],StreamEntryID> streams)

Read from one or more streams as a consumer group.

Parameters:

groupName - Consumer group name.

consumer - Consumer name.

xReadGroupParams - XReadGroupParams

streams - Map of stream name and ID to read from.

Returns:

List of entries. Each entry in the list is a pair of stream name and the entries reported for that key.

xreadGroupBinaryAsMap

java.util.Map<byte[],java.util.List<StreamEntryBinary>> xreadGroupBinaryAsMap(byte[] groupName,
                                                                              byte[] consumer,
                                                                              XReadGroupParams xReadGroupParams,
                                                                              java.util.Map<byte[],StreamEntryID> streams)

Read from one or more streams as a consumer group and return a map of stream name to list of entries.

Parameters:

groupName - Consumer group name.

consumer - Consumer name.

xReadGroupParams - XReadGroupParams

streams - Map of stream name and ID to read from.

Returns:

Map of stream name to list of entries. key is the stream name and value is the list of entries reported for that key.