redis.clients.jedis.commands

Interface StreamPipelineCommands

All Known Subinterfaces:

PipelineCommands

All Known Implementing Classes:

AbstractPipeline, AbstractTransaction, ClusterPipeline, MultiClusterPipeline, MultiClusterTransaction, MultiNodePipelineBase, Pipeline, PipelineBase, PipeliningBase, ReliableTransaction, ShardedPipeline, Transaction, TransactionBase

public interface StreamPipelineCommands

Method Summary

Modifier and Type	Method and Description
Response<java.lang.Long>	xack(java.lang.String key, java.lang.String group, StreamEntryID... ids) XACK key group ID [ID ...]
default Response<StreamEntryID>	xadd(java.lang.String key, java.util.Map<java.lang.String,java.lang.String> hash, XAddParams params) XADD key [NOMKSTREAM] [MAXLEN|MINID [=|~] threshold [LIMIT count]] *|ID field value [field value ...]
Response<StreamEntryID>	xadd(java.lang.String key, StreamEntryID id, java.util.Map<java.lang.String,java.lang.String> hash) XADD key ID field string [field string ...]
Response<StreamEntryID>	xadd(java.lang.String key, XAddParams params, java.util.Map<java.lang.String,java.lang.String> hash)
Response<java.util.Map.Entry<StreamEntryID,java.util.List<StreamEntry>>>	xautoclaim(java.lang.String key, java.lang.String group, java.lang.String consumerName, long minIdleTime, StreamEntryID start, XAutoClaimParams params) XAUTOCLAIM key group consumer min-idle-time start [COUNT count]
Response<java.util.Map.Entry<StreamEntryID,java.util.List<StreamEntryID>>>	xautoclaimJustId(java.lang.String key, java.lang.String group, java.lang.String consumerName, long minIdleTime, StreamEntryID start, XAutoClaimParams params) XAUTOCLAIM key group consumer min-idle-time start [COUNT count] JUSTID
Response<java.util.List<StreamEntry>>	xclaim(java.lang.String key, java.lang.String group, java.lang.String consumerName, long minIdleTime, XClaimParams params, StreamEntryID... ids) {@code XCLAIM key group consumer min-idle-time ...
Response<java.util.List<StreamEntryID>>	xclaimJustId(java.lang.String key, java.lang.String group, java.lang.String consumerName, long minIdleTime, XClaimParams params, StreamEntryID... ids) {@code XCLAIM key group consumer min-idle-time ...
Response<java.lang.Long>	xdel(java.lang.String key, StreamEntryID... ids) XDEL key ID [ID ...]
Response<java.lang.String>	xgroupCreate(java.lang.String key, java.lang.String groupName, StreamEntryID id, boolean makeStream) XGROUP CREATE key groupName <id or $>
Response<java.lang.Boolean>	xgroupCreateConsumer(java.lang.String key, java.lang.String groupName, java.lang.String consumerName) XGROUP CREATECONSUMER key groupName consumerName
Response<java.lang.Long>	xgroupDelConsumer(java.lang.String key, java.lang.String groupName, java.lang.String consumerName) XGROUP DELCONSUMER key groupName consumerName
Response<java.lang.Long>	xgroupDestroy(java.lang.String key, java.lang.String groupName) XGROUP DESTROY key groupName
Response<java.lang.String>	xgroupSetID(java.lang.String key, java.lang.String groupName, StreamEntryID id) XGROUP SETID key groupName <id or $>
Response<java.util.List<StreamConsumersInfo>>	xinfoConsumers(java.lang.String key, java.lang.String group) Deprecated. Use xinfoConsumers2(java.lang.String, java.lang.String).
Response<java.util.List<StreamConsumerInfo>>	xinfoConsumers2(java.lang.String key, java.lang.String group) Introspection command used in order to retrieve different information about consumers in the group
Response<java.util.List<StreamGroupInfo>>	xinfoGroups(java.lang.String key) Introspection command used in order to retrieve different information about groups in the stream
Response<StreamInfo>	xinfoStream(java.lang.String key) Introspection command used in order to retrieve different information about the stream
Response<StreamFullInfo>	xinfoStreamFull(java.lang.String key) Introspection command used in order to retrieve all information about the stream
Response<StreamFullInfo>	xinfoStreamFull(java.lang.String key, int count) Introspection command used in order to retrieve all information about the stream
Response<java.lang.Long>	xlen(java.lang.String key) XLEN key
Response<StreamPendingSummary>	xpending(java.lang.String key, java.lang.String groupName) XPENDING key group
Response<java.util.List<StreamPendingEntry>>	xpending(java.lang.String key, java.lang.String groupName, XPendingParams params) XPENDING key group [[IDLE min-idle-time] start end count [consumer]]
Response<java.util.List<StreamEntry>>	xrange(java.lang.String key, StreamEntryID start, StreamEntryID end) XRANGE key start end
Response<java.util.List<StreamEntry>>	xrange(java.lang.String key, StreamEntryID start, StreamEntryID end, int count) XRANGE key start end COUNT count
Response<java.util.List<StreamEntry>>	xrange(java.lang.String key, java.lang.String start, java.lang.String end)
Response<java.util.List<StreamEntry>>	xrange(java.lang.String key, java.lang.String start, java.lang.String end, int count)
Response<java.util.List<java.util.Map.Entry<java.lang.String,java.util.List<StreamEntry>>>>	xread(XReadParams xReadParams, java.util.Map<java.lang.String,StreamEntryID> streams) XREAD [COUNT count] [BLOCK milliseconds] STREAMS key [key ...]
Response<java.util.Map<java.lang.String,java.util.List<StreamEntry>>>	xreadAsMap(XReadParams xReadParams, java.util.Map<java.lang.String,StreamEntryID> streams) XREAD [COUNT count] [BLOCK milliseconds] STREAMS key [key ...]
Response<java.util.List<java.util.Map.Entry<java.lang.String,java.util.List<StreamEntry>>>>	xreadGroup(java.lang.String groupName, java.lang.String consumer, XReadGroupParams xReadGroupParams, java.util.Map<java.lang.String,StreamEntryID> streams) XREADGROUP GROUP group consumer [COUNT count] [BLOCK milliseconds] [NOACK] STREAMS key [key ...] id [id ...]
Response<java.util.Map<java.lang.String,java.util.List<StreamEntry>>>	xreadGroupAsMap(java.lang.String groupName, java.lang.String consumer, XReadGroupParams xReadGroupParams, java.util.Map<java.lang.String,StreamEntryID> streams) XREADGROUP GROUP group consumer [COUNT count] [BLOCK milliseconds] [NOACK] STREAMS key [key ...] id [id ...]
Response<java.util.List<StreamEntry>>	xrevrange(java.lang.String key, StreamEntryID end, StreamEntryID start) XREVRANGE key end start
Response<java.util.List<StreamEntry>>	xrevrange(java.lang.String key, StreamEntryID end, StreamEntryID start, int count) XREVRANGE key end start COUNT count
Response<java.util.List<StreamEntry>>	xrevrange(java.lang.String key, java.lang.String end, java.lang.String start)
Response<java.util.List<StreamEntry>>	xrevrange(java.lang.String key, java.lang.String end, java.lang.String start, int count)
Response<java.lang.Long>	xtrim(java.lang.String key, long maxLen, boolean approximate) XTRIM key MAXLEN [~] count
Response<java.lang.Long>	xtrim(java.lang.String key, XTrimParams params) XTRIM key MAXLEN|MINID [=|~] threshold [LIMIT count]

Method Detail

xadd

Response<StreamEntryID> xadd(java.lang.String key,
                             StreamEntryID id,
                             java.util.Map<java.lang.String,java.lang.String> hash)

XADD key ID field string [field string ...]

Returns:

the ID of the added entry

xadd

default Response<StreamEntryID> xadd(java.lang.String key,
                                     java.util.Map<java.lang.String,java.lang.String> hash,
                                     XAddParams params)

XADD key [NOMKSTREAM] [MAXLEN|MINID [=|~] threshold [LIMIT count]] *|ID field value [field value ...]

Returns:

the ID of the added entry

xadd

Response<StreamEntryID> xadd(java.lang.String key,
                             XAddParams params,
                             java.util.Map<java.lang.String,java.lang.String> hash)

xlen

Response<java.lang.Long> xlen(java.lang.String key)

XLEN key

Returns:

length of stream

xrange

Response<java.util.List<StreamEntry>> xrange(java.lang.String key,
                                             StreamEntryID start,
                                             StreamEntryID end)

XRANGE key start end

Parameters:

key - key

start - minimum StreamEntryID for the retrieved range, passing null will indicate minimum ID possible in the stream

end - maximum StreamEntryID for the retrieved range, passing null will indicate maximum ID possible in the stream

Returns:

The entries with IDs matching the specified range.

xrange

Response<java.util.List<StreamEntry>> xrange(java.lang.String key,
                                             StreamEntryID start,
                                             StreamEntryID end,
                                             int count)

XRANGE key start end COUNT count

Parameters:

key - key

start - minimum StreamEntryID for the retrieved range, passing null will indicate minimum ID possible in the stream

end - maximum StreamEntryID for the retrieved range, passing null will indicate maximum ID possible in the stream

count - maximum number of entries returned

Returns:

The entries with IDs matching the specified range.

xrevrange

Response<java.util.List<StreamEntry>> xrevrange(java.lang.String key,
                                                StreamEntryID end,
                                                StreamEntryID start)

XREVRANGE key end start

Parameters:

key - key

start - minimum StreamEntryID for the retrieved range, passing null will indicate minimum ID possible in the stream

end - maximum StreamEntryID for the retrieved range, passing null will indicate maximum ID possible in the stream

Returns:

the entries with IDs matching the specified range, from the higher ID to the lower ID matching.

xrevrange

Response<java.util.List<StreamEntry>> xrevrange(java.lang.String key,
                                                StreamEntryID end,
                                                StreamEntryID start,
                                                int count)

XREVRANGE key end start COUNT count

Parameters:

key - key

start - minimum StreamEntryID for the retrieved range, passing null will indicate minimum ID possible in the stream

end - maximum StreamEntryID for the retrieved range, passing null will indicate maximum ID possible in the stream

count - The entries with IDs matching the specified range.

Returns:

the entries with IDs matching the specified range, from the higher ID to the lower ID matching.

xrange

Response<java.util.List<StreamEntry>> xrange(java.lang.String key,
                                             java.lang.String start,
                                             java.lang.String end)

xrange

Response<java.util.List<StreamEntry>> xrange(java.lang.String key,
                                             java.lang.String start,
                                             java.lang.String end,
                                             int count)

xrevrange

Response<java.util.List<StreamEntry>> xrevrange(java.lang.String key,
                                                java.lang.String end,
                                                java.lang.String start)

xrevrange

Response<java.util.List<StreamEntry>> xrevrange(java.lang.String key,
                                                java.lang.String end,
                                                java.lang.String start,
                                                int count)

xack

Response<java.lang.Long> xack(java.lang.String key,
                              java.lang.String group,
                              StreamEntryID... ids)

XACK key group ID [ID ...]

xgroupCreate

Response<java.lang.String> xgroupCreate(java.lang.String key,
                                        java.lang.String groupName,
                                        StreamEntryID id,
                                        boolean makeStream)

XGROUP CREATE key groupName <id or $>

xgroupSetID

Response<java.lang.String> xgroupSetID(java.lang.String key,
                                       java.lang.String groupName,
                                       StreamEntryID id)

XGROUP SETID key groupName <id or $>

xgroupDestroy

Response<java.lang.Long> xgroupDestroy(java.lang.String key,
                                       java.lang.String groupName)

XGROUP DESTROY key groupName

xgroupCreateConsumer

Response<java.lang.Boolean> xgroupCreateConsumer(java.lang.String key,
                                                 java.lang.String groupName,
                                                 java.lang.String consumerName)

XGROUP CREATECONSUMER key groupName consumerName

xgroupDelConsumer

Response<java.lang.Long> xgroupDelConsumer(java.lang.String key,
                                           java.lang.String groupName,
                                           java.lang.String consumerName)

XGROUP DELCONSUMER key groupName consumerName

xpending

Response<StreamPendingSummary> xpending(java.lang.String key,
                                        java.lang.String groupName)

XPENDING key group

xpending

Response<java.util.List<StreamPendingEntry>> xpending(java.lang.String key,
                                                      java.lang.String groupName,
                                                      XPendingParams params)

XPENDING key group [[IDLE min-idle-time] start end count [consumer]]

xdel

Response<java.lang.Long> xdel(java.lang.String key,
                              StreamEntryID... ids)

XDEL key ID [ID ...]

xtrim

Response<java.lang.Long> xtrim(java.lang.String key,
                               long maxLen,
                               boolean approximate)

XTRIM key MAXLEN [~] count

xtrim

Response<java.lang.Long> xtrim(java.lang.String key,
                               XTrimParams params)

XTRIM key MAXLEN|MINID [=|~] threshold [LIMIT count]

xclaim

Response<java.util.List<StreamEntry>> xclaim(java.lang.String key,
                                             java.lang.String group,
                                             java.lang.String consumerName,
                                             long minIdleTime,
                                             XClaimParams params,
                                             StreamEntryID... ids)

XCLAIM key group consumer min-idle-time <ID-1> ... <ID-N> [IDLE <milliseconds>] [TIME <mstime>] [RETRYCOUNT <count>] [FORCE]

xclaimJustId

Response<java.util.List<StreamEntryID>> xclaimJustId(java.lang.String key,
                                                     java.lang.String group,
                                                     java.lang.String consumerName,
                                                     long minIdleTime,
                                                     XClaimParams params,
                                                     StreamEntryID... ids)

XCLAIM key group consumer min-idle-time <ID-1> ... <ID-N> [IDLE <milliseconds>] [TIME <mstime>] [RETRYCOUNT <count>] [FORCE] JUSTID

xautoclaim

Response<java.util.Map.Entry<StreamEntryID,java.util.List<StreamEntry>>> xautoclaim(java.lang.String key,
                                                                                    java.lang.String group,
                                                                                    java.lang.String consumerName,
                                                                                    long minIdleTime,
                                                                                    StreamEntryID start,
                                                                                    XAutoClaimParams params)

XAUTOCLAIM key group consumer min-idle-time start [COUNT count]

Parameters:

key - Stream Key

group - Consumer Group

consumerName - Consumer name to transfer the auto claimed entries

minIdleTime - Entries pending more than minIdleTime will be transferred ownership

start - StreamEntryID - Entries ≥ start will be transferred ownership, passing null will indicate '-'

params - XAutoClaimParams

xautoclaimJustId

Response<java.util.Map.Entry<StreamEntryID,java.util.List<StreamEntryID>>> xautoclaimJustId(java.lang.String key,
                                                                                            java.lang.String group,
                                                                                            java.lang.String consumerName,
                                                                                            long minIdleTime,
                                                                                            StreamEntryID start,
                                                                                            XAutoClaimParams params)

XAUTOCLAIM key group consumer min-idle-time start [COUNT count] JUSTID

Parameters:

key - Stream Key

group - Consumer Group

consumerName - Consumer name to transfer the auto claimed entries

minIdleTime - Entries pending more than minIdleTime will be transferred ownership

start - StreamEntryID - Entries ≥ start will be transferred ownership, passing null will indicate '-'

params - XAutoClaimParams

xinfoStream

Response<StreamInfo> xinfoStream(java.lang.String key)

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

Parameters:

key - Stream name

Returns:

StreamInfo that contains information about the stream

xinfoStreamFull

Response<StreamFullInfo> xinfoStreamFull(java.lang.String key)

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

Parameters:

key - Stream name

Returns:

StreamFullInfo that contains information about the stream

xinfoStreamFull

Response<StreamFullInfo> xinfoStreamFull(java.lang.String key,
                                         int count)

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

Parameters:

key - Stream name

count - stream info count

Returns:

StreamFullInfo that contains information about the stream

xinfoGroups

Response<java.util.List<StreamGroupInfo>> xinfoGroups(java.lang.String key)

Introspection command used in order to retrieve different information about groups in the stream

Parameters:

key - Stream name

Returns:

List of StreamGroupInfo containing information about groups

xinfoConsumers

@Deprecated
Response<java.util.List<StreamConsumersInfo>> xinfoConsumers(java.lang.String key,
                                                                         java.lang.String group)

Deprecated. Use xinfoConsumers2(java.lang.String, java.lang.String).

Introspection command used in order to retrieve different information about consumers in the group

Parameters:

key - Stream name

group - Group name

Returns:

List of StreamConsumersInfo containing information about consumers that belong to the group

xinfoConsumers2

Response<java.util.List<StreamConsumerInfo>> xinfoConsumers2(java.lang.String key,
                                                             java.lang.String group)

Introspection command used in order to retrieve different information about consumers in the group

Parameters:

key - Stream name

group - Group name

Returns:

List of StreamConsumerInfo containing information about consumers that belong to the group

xread

Response<java.util.List<java.util.Map.Entry<java.lang.String,java.util.List<StreamEntry>>>> xread(XReadParams xReadParams,
                                                                                                  java.util.Map<java.lang.String,StreamEntryID> streams)

XREAD [COUNT count] [BLOCK milliseconds] STREAMS key [key ...] ID [ID ...]

xreadAsMap

Response<java.util.Map<java.lang.String,java.util.List<StreamEntry>>> xreadAsMap(XReadParams xReadParams,
                                                                                 java.util.Map<java.lang.String,StreamEntryID> streams)

XREAD [COUNT count] [BLOCK milliseconds] STREAMS key [key ...] ID [ID ...]

xreadGroup

Response<java.util.List<java.util.Map.Entry<java.lang.String,java.util.List<StreamEntry>>>> xreadGroup(java.lang.String groupName,
                                                                                                       java.lang.String consumer,
                                                                                                       XReadGroupParams xReadGroupParams,
                                                                                                       java.util.Map<java.lang.String,StreamEntryID> streams)

XREADGROUP GROUP group consumer [COUNT count] [BLOCK milliseconds] [NOACK] STREAMS key [key ...] id [id ...]

xreadGroupAsMap

Response<java.util.Map<java.lang.String,java.util.List<StreamEntry>>> xreadGroupAsMap(java.lang.String groupName,
                                                                                      java.lang.String consumer,
                                                                                      XReadGroupParams xReadGroupParams,
                                                                                      java.util.Map<java.lang.String,StreamEntryID> streams)

XREADGROUP GROUP group consumer [COUNT count] [BLOCK milliseconds] [NOACK] STREAMS key [key ...] id [id ...]