Interface BoundStreamOperations<K,HK,HV>

@NullUnmarked
public interface BoundStreamOperations<K,HK,HV>

Redis stream specific operations bound to a certain key.

Since:

2.2

Author:

Mark Paluch, Christoph Strobl, Dengliming, Viktoriya Kutsarova

Method Summary

Modifier and Type	Method	Description
Long	acknowledge(@NonNull String group, @NonNull String @NonNull ... recordIds)	Acknowledge one or more records as processed.
List<RedisStreamCommands.StreamEntryDeletionResult>	acknowledgeAndDelete(@NonNull String group, @NonNull RedisStreamCommands.XDelOptions options, @NonNull String @NonNull ... recordIds)	Acknowledges and conditionally deletes one or multiple entries for a stream consumer group at the specified key.
List<RedisStreamCommands.StreamEntryDeletionResult>	acknowledgeAndDelete(@NonNull String group, @NonNull RedisStreamCommands.XDelOptions options, @NonNull RecordId @NonNull ... recordIds)	Acknowledges and conditionally deletes one or multiple entries for a stream consumer group at the specified key.
RecordId	add(@NonNull Map<@NonNull HK, HV> body)	Append a record to the stream key.
RecordId	add(@NonNull Map<@NonNull HK, HV> content, @NonNull RedisStreamCommands.XAddOptions xAddOptions)	Append a record to the stream key with the specified options.
String	createGroup(@NonNull ReadOffset readOffset, @NonNull String group)	Create a consumer group.
Long	delete(@NonNull String @NonNull ... recordIds)	Removes the specified entries from the stream.
Boolean	deleteConsumer(@NonNull Consumer consumer)	Delete a consumer from a consumer group.
List<RedisStreamCommands.StreamEntryDeletionResult>	deleteWithOptions(@NonNull RedisStreamCommands.XDelOptions options, @NonNull String @NonNull ... recordIds)	Deletes one or multiple entries from the stream at the specified key with extended options.
List<RedisStreamCommands.StreamEntryDeletionResult>	deleteWithOptions(@NonNull RedisStreamCommands.XDelOptions options, @NonNull RecordId @NonNull ... recordIds)	Deletes one or multiple entries from the stream at the specified key with extended options.
Boolean	destroyGroup(@NonNull String group)	Destroy a consumer group.
default List<@NonNull MapRecord<K,HK,HV>>	range(@NonNull Range<String> range)	Read records from a stream within a specific Range.
List<@NonNull MapRecord<K,HK,HV>>	range(@NonNull Range<String> range, @NonNull Limit limit)	Read records from a stream within a specific Range applying a Limit.
default List<@NonNull MapRecord<K,HK,HV>>	read(@NonNull Consumer consumer, @NonNull ReadOffset readOffset)	Read records starting from ReadOffset. using a consumer group.
List<@NonNull MapRecord<K,HK,HV>>	read(@NonNull Consumer consumer, @NonNull StreamReadOptions readOptions, @NonNull ReadOffset readOffset)	Read records starting from ReadOffset. using a consumer group.
default List<@NonNull MapRecord<K,HK,HV>>	read(@NonNull ReadOffset readOffset)	Read records from ReadOffset.
List<@NonNull MapRecord<K,HK,HV>>	read(@NonNull StreamReadOptions readOptions, @NonNull ReadOffset readOffset)	Read records starting from ReadOffset.
default List<@NonNull MapRecord<K,HK,HV>>	reverseRange(@NonNull Range<String> range)	Read records from a stream within a specific Range in reverse order.
List<@NonNull MapRecord<K,HK,HV>>	reverseRange(@NonNull Range<String> range, @NonNull Limit limit)	Read records from a stream within a specific Range applying a Limit in reverse order.
Long	size()	Get the length of a stream.
Long	trim(long count)	Trims the stream to count elements.
Long	trim(long count, boolean approximateTrimming)	Trims the stream to count elements.
Long	trim(@NonNull RedisStreamCommands.XTrimOptions options)	Trims the stream according to the specified RedisStreamCommands.XTrimOptions.

Method Details

acknowledge

Long acknowledge(@NonNull String group,
 @NonNull String @NonNull ... recordIds)

Acknowledge one or more records as processed.

Parameters:

group - name of the consumer group.

recordIds - record Id's to acknowledge.

Returns:

length of acknowledged records. null when used in pipeline / transaction.

See Also:

• Redis Documentation: XACK

add

RecordId add(@NonNull Map<@NonNull HK, HV> body)

Append a record to the stream key.

Parameters:

body - record body.

Returns:

the record Id. null when used in pipeline / transaction.

See Also:

• Redis Documentation: XADD

add

RecordId add(@NonNull Map<@NonNull HK, HV> content,
 @NonNull RedisStreamCommands.XAddOptions xAddOptions)

Append a record to the stream key with the specified options.

Parameters:

content - record content as Map.

xAddOptions - additional parameters for the XADD call.

Returns:

the record Id. null when used in pipeline / transaction.

Since:

3.4

See Also:

• Redis Documentation: XADD

delete

Long delete(@NonNull String @NonNull ... recordIds)

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:

recordIds - stream record Id's.

Returns:

number of removed entries. null when used in pipeline / transaction.

See Also:

• Redis Documentation: XDEL

deleteWithOptions

List<RedisStreamCommands.StreamEntryDeletionResult> deleteWithOptions(@NonNull RedisStreamCommands.XDelOptions options,
 @NonNull String @NonNull ... recordIds)

Deletes one or multiple entries from the stream at the specified key with extended options.

Parameters:

options - the RedisStreamCommands.XDelOptions specifying deletion policy.

recordIds - stream record Id's as strings.

Returns:

list of RedisStreamCommands.StreamEntryDeletionResult for each ID.

Since:

4.1

See Also:

• Redis Documentation: XDELEX

deleteWithOptions

List<RedisStreamCommands.StreamEntryDeletionResult> deleteWithOptions(@NonNull RedisStreamCommands.XDelOptions options,
 @NonNull RecordId @NonNull ... recordIds)

Deletes one or multiple entries from the stream at the specified key with extended options.

Parameters:

options - the RedisStreamCommands.XDelOptions specifying deletion policy.

recordIds - stream record Id's.

Returns:

list of RedisStreamCommands.StreamEntryDeletionResult for each ID.

Since:

4.1

See Also:

• Redis Documentation: XDELEX

acknowledgeAndDelete

List<RedisStreamCommands.StreamEntryDeletionResult> acknowledgeAndDelete(@NonNull String group,
 @NonNull RedisStreamCommands.XDelOptions options,
 @NonNull String @NonNull ... recordIds)

Acknowledges and conditionally deletes one or multiple entries for a stream consumer group at the specified key.

Parameters:

group - name of the consumer group.

options - the RedisStreamCommands.XDelOptions specifying deletion policy.

recordIds - stream record Id's as strings.

Returns:

list of RedisStreamCommands.StreamEntryDeletionResult for each ID.

Since:

4.1

See Also:

• Redis Documentation: XACKDEL

acknowledgeAndDelete

List<RedisStreamCommands.StreamEntryDeletionResult> acknowledgeAndDelete(@NonNull String group,
 @NonNull RedisStreamCommands.XDelOptions options,
 @NonNull RecordId @NonNull ... recordIds)

Acknowledges and conditionally deletes one or multiple entries for a stream consumer group at the specified key.

Parameters:

group - name of the consumer group.

options - the RedisStreamCommands.XDelOptions specifying deletion policy.

recordIds - stream record Id's.

Returns:

list of RedisStreamCommands.StreamEntryDeletionResult for each ID.

Since:

4.1

See Also:

• Redis Documentation: XACKDEL

createGroup

String createGroup(@NonNull ReadOffset readOffset,
 @NonNull String group)

Create a consumer group.

Parameters:

readOffset -

group - name of the consumer group.

Returns:

true if successful. null when used in pipeline / transaction.

deleteConsumer

Boolean deleteConsumer(@NonNull Consumer consumer)

Delete a consumer from a consumer group.

Parameters:

consumer - consumer identified by group name and consumer key.

Returns:

true if successful. null when used in pipeline / transaction.

destroyGroup

Boolean destroyGroup(@NonNull String group)

Destroy a consumer group.

Parameters:

group - name of the consumer group.

Returns:

true if successful. null when used in pipeline / transaction.

size

Long size()

Get the length of a stream.

Returns:

length of the stream. null when used in pipeline / transaction.

See Also:

• Redis Documentation: XLEN

range

default List<@NonNull MapRecord<K,HK,HV>> range(@NonNull Range<String> range)

Read records from a stream within a specific Range.

Parameters:

range - must not be null.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

• Redis Documentation: XRANGE

range

List<@NonNull MapRecord<K,HK,HV>> range(@NonNull Range<String> range,
 @NonNull Limit limit)

Read records from a stream within a specific Range applying a Limit.

Parameters:

range - must not be null.

limit - must not be null.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

• Redis Documentation: XRANGE

read

default List<@NonNull MapRecord<K,HK,HV>> read(@NonNull ReadOffset readOffset)

Read records from ReadOffset.

Parameters:

readOffset - the offset to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

• Redis Documentation: XREAD

read

List<@NonNull MapRecord<K,HK,HV>> read(@NonNull StreamReadOptions readOptions,
 @NonNull ReadOffset readOffset)

Read records starting from ReadOffset.

Parameters:

readOptions - read arguments.

readOffset - the offset to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

• Redis Documentation: XREAD

read

default List<@NonNull MapRecord<K,HK,HV>> read(@NonNull Consumer consumer,
 @NonNull ReadOffset readOffset)

Read records starting from ReadOffset. using a consumer group.

Parameters:

consumer - consumer/group.

readOffset - the offset to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

• Redis Documentation: XREADGROUP

read

List<@NonNull MapRecord<K,HK,HV>> read(@NonNull Consumer consumer,
 @NonNull StreamReadOptions readOptions,
 @NonNull ReadOffset readOffset)

Read records starting from ReadOffset. using a consumer group.

Parameters:

consumer - consumer/group.

readOptions - read arguments.

readOffset - the offset to read from.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

• Redis Documentation: XREADGROUP

reverseRange

default List<@NonNull MapRecord<K,HK,HV>> reverseRange(@NonNull Range<String> range)

Read records from a stream within a specific Range in reverse order.

Parameters:

range - must not be null.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

• Redis Documentation: XREVRANGE

reverseRange

List<@NonNull MapRecord<K,HK,HV>> reverseRange(@NonNull Range<String> range,
 @NonNull Limit limit)

Read records from a stream within a specific Range applying a Limit in reverse order.

Parameters:

range - must not be null.

limit - must not be null.

Returns:

list with members of the resulting stream. null when used in pipeline / transaction.

See Also:

• Redis Documentation: XREVRANGE

trim

Long trim(long count)

Trims the stream to count elements.

Parameters:

count - length of the stream.

Returns:

number of removed entries. null when used in pipeline / transaction.

See Also:

• Redis Documentation: XTRIM

trim

Long trim(long count,
 boolean approximateTrimming)

Trims the stream to count elements.

Parameters:

count - length of the stream.

approximateTrimming - the trimming must be performed in a approximated way in order to maximize performances.

Returns:

number of removed entries. null when used in pipeline / transaction.

Since:

2.4

See Also:

• Redis Documentation: XTRIM

trim

Long trim(@NonNull RedisStreamCommands.XTrimOptions options)

Trims the stream according to the specified RedisStreamCommands.XTrimOptions.

Supports various trimming strategies including MAXLEN (limit by count) and MINID (evict entries older than a specific ID), with options for approximate or exact trimming.

Parameters:

options - the trimming options specifying the strategy and parameters. Must not be null.

Returns:

number of removed entries. null when used in pipeline / transaction.

Since:

2.7.4

See Also:

• Redis Documentation: XTRIM