ReactiveStreamOperations (Spring Data Redis 2.2.0.RELEASE API)

All Superinterfaces:

HashMapperProvider<HK,HV>
```
public interface ReactiveStreamOperations<K,HK,HV>
extends HashMapperProvider<HK,HV>
```
Redis stream specific operations.

Since:

2.2

Author:

Mark Paluch, Christoph Strobl

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`reactor.core.publisher.Mono<Long>`	`acknowledge(K key, String group, RecordId... recordIds)` Acknowledge one or more records as processed.
`default reactor.core.publisher.Mono<Long>`	`acknowledge(K key, String group, String... recordIds)` Acknowledge one or more records as processed.
`default reactor.core.publisher.Mono<Long>`	`acknowledge(String group, Record<K,?> record)` Acknowledge the given record as processed.
`default reactor.core.publisher.Mono<RecordId>`	`add(K key, Map<? extends HK,? extends HV> content)` Append a record to the stream `key`.
`default reactor.core.publisher.Flux<RecordId>`	`add(K key, org.reactivestreams.Publisher<? extends Map<? extends HK,? extends HV>> bodyPublisher)` Append one or more records to the stream `key`.
`default reactor.core.publisher.Mono<RecordId>`	`add(MapRecord<K,? extends HK,? extends HV> record)` Append a record, backed by a `Map` holding the field/value pairs, to the stream.
`reactor.core.publisher.Mono<RecordId>`	`add(Record<K,?> record)` Append the record, backed by the given value, to the stream.
`reactor.core.publisher.Mono<String>`	`createGroup(K key, ReadOffset readOffset, String group)` Create a consumer group.
`default reactor.core.publisher.Mono<String>`	`createGroup(K key, String group)` Create a consumer group at the `latest offset`.
`reactor.core.publisher.Mono<Long>`	`delete(K key, RecordId... recordIds)` Removes the specified records from the stream.
`default reactor.core.publisher.Mono<Long>`	`delete(K key, String... recordIds)` Removes the specified records from the stream.
`default reactor.core.publisher.Mono<Long>`	`delete(Record<K,?> record)` Removes a given `Record` from the stream.
`reactor.core.publisher.Mono<String>`	`deleteConsumer(K key, Consumer consumer)` Delete a consumer from a consumer group.
`reactor.core.publisher.Mono<String>`	`destroyGroup(K key, String group)` Destroy a consumer group.
`<V> HashMapper<V,HK,HV>`	`getHashMapper(Class<V> targetType)` Get the `HashMapper` for a specific type.
`default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>>`	`range(Class<V> targetType, K key, Range<String> range)` Read all records from a stream within a specific `Range`.
`default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>>`	`range(Class<V> targetType, K key, Range<String> range, RedisZSetCommands.Limit limit)` Read records from a stream within a specific `Range` applying a `RedisZSetCommands.Limit`.
`default reactor.core.publisher.Flux<MapRecord<K,HK,HV>>`	`range(K key, Range<String> range)` Read records from a stream within a specific `Range`.
`reactor.core.publisher.Flux<MapRecord<K,HK,HV>>`	`range(K key, Range<String> range, RedisZSetCommands.Limit limit)` Read records from a stream within a specific `Range` applying a `RedisZSetCommands.Limit`.
`default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>>`	`read(Class<V> targetType, Consumer consumer, StreamOffset<K>... streams)` Read records from one or more `StreamOffset`s using a consumer group as `ObjectRecord`.
`default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>>`	`read(Class<V> targetType, Consumer consumer, StreamReadOptions readOptions, StreamOffset<K>... streams)` Read records from one or more `StreamOffset`s using a consumer group as `ObjectRecord`.
`default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>>`	`read(Class<V> targetType, StreamOffset<K>... streams)` Read records from one or more `StreamOffset`s as `ObjectRecord`.
`default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>>`	`read(Class<V> targetType, StreamOffset<K> stream)` Read records from a `StreamOffset` as `ObjectRecord`.
`default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>>`	`read(Class<V> targetType, StreamReadOptions readOptions, StreamOffset<K>... streams)` Read records from one or more `StreamOffset`s as `ObjectRecord`.
`default reactor.core.publisher.Flux<MapRecord<K,HK,HV>>`	`read(Consumer consumer, StreamOffset<K>... streams)` Read records from one or more `StreamOffset`s using a consumer group.
`reactor.core.publisher.Flux<MapRecord<K,HK,HV>>`	`read(Consumer consumer, StreamReadOptions readOptions, StreamOffset<K>... streams)` Read records from one or more `StreamOffset`s using a consumer group.
`default reactor.core.publisher.Flux<MapRecord<K,HK,HV>>`	`read(StreamOffset<K>... streams)` Read records from one or more `StreamOffset`s.
`default reactor.core.publisher.Flux<MapRecord<K,HK,HV>>`	`read(StreamOffset<K> stream)` Read records from a `StreamOffset` as `ObjectRecord`.
`reactor.core.publisher.Flux<MapRecord<K,HK,HV>>`	`read(StreamReadOptions readOptions, StreamOffset<K>... streams)` Read records from one or more `StreamOffset`s.
`default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>>`	`reverseRange(Class<V> targetType, K key, Range<String> range)` Read records from a stream within a specific `Range` in reverse order as `ObjectRecord`.
`default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>>`	`reverseRange(Class<V> targetType, K key, Range<String> range, RedisZSetCommands.Limit limit)` Read records from a stream within a specific `Range` applying a `RedisZSetCommands.Limit` in reverse order as `ObjectRecord`.
`default reactor.core.publisher.Flux<MapRecord<K,HK,HV>>`	`reverseRange(K key, Range<String> range)` Read records from a stream within a specific `Range` in reverse order.
`reactor.core.publisher.Flux<MapRecord<K,HK,HV>>`	`reverseRange(K key, Range<String> range, RedisZSetCommands.Limit limit)` Read records from a stream within a specific `Range` applying a `RedisZSetCommands.Limit` in reverse order.
`reactor.core.publisher.Mono<Long>`	`size(K key)` Get the length of a stream.
`reactor.core.publisher.Mono<Long>`	`trim(K key, long count)` Trims the stream to `count` elements.

Method Detail

acknowledge

default reactor.core.publisher.Mono<Long> acknowledge(K key,
                                                      String group,
                                                      String... recordIds)

Acknowledge one or more records as processed.

Parameters:: key - the stream key.; group - name of the consumer group.; recordIds - record Id's to acknowledge.
Returns:: the Mono emitting the length of acknowledged records.
See Also:: Redis Documentation: XACK

acknowledge

reactor.core.publisher.Mono<Long> acknowledge(K key,
                                              String group,
                                              RecordId... recordIds)

Acknowledge one or more records as processed.

Parameters:: key - the stream key.; group - name of the consumer group.; recordIds - record Id's to acknowledge.
Returns:: the Mono emitting the length of acknowledged records.
See Also:: Redis Documentation: XACK

acknowledge
```
default reactor.core.publisher.Mono<Long> acknowledge(String group,
                                                      Record<K,?> record)
```
Acknowledge the given record as processed.

Parameters:

group - name of the consumer group.

record - the Record to acknowledge.

Returns:

the Mono emitting the length of acknowledged records.

See Also:

Redis Documentation: XACK

add

default reactor.core.publisher.Flux<RecordId> add(K key,
                                                  org.reactivestreams.Publisher<? extends Map<? extends HK,? extends HV>> bodyPublisher)

Append one or more records to the stream key.

Parameters:: key - the stream key.; bodyPublisher - record body Publisher.
Returns:: the record Ids.
See Also:: Redis Documentation: XADD

add

default reactor.core.publisher.Mono<RecordId> add(K key,
                                                  Map<? extends HK,? extends HV> content)

Append a record to the stream key.

Parameters:: key - the stream key.; content - record content as Map.
Returns:: the Mono emitting the RecordId.
See Also:: Redis Documentation: XADD

add
```
default reactor.core.publisher.Mono<RecordId> add(MapRecord<K,? extends HK,? extends HV> record)
```
Append a record, backed by a Map holding the field/value pairs, to the stream.

Parameters:

record - the record to append.

Returns:

the Mono emitting the RecordId.

See Also:

Redis Documentation: XADD

add
```
reactor.core.publisher.Mono<RecordId> add(Record<K,?> record)
```
Append the record, backed by the given value, to the stream. The value will be hashed and serialized.

Parameters:

record - must not be null.

Returns:

the Mono emitting the RecordId.

See Also:

MapRecord, ObjectRecord

delete
```
default reactor.core.publisher.Mono<Long> delete(K key,
                                                 String... recordIds)
```
Removes the specified records from the stream. Returns the number of records deleted, that may be different from the number of IDs passed in case certain IDs do not exist.

Parameters:

key - the stream key.

recordIds - stream record Id's.

Returns:

the Mono emitting the number of removed records.

See Also:

Redis Documentation: XDEL

delete
```
default reactor.core.publisher.Mono<Long> delete(Record<K,?> record)
```
Removes a given Record from the stream.

Parameters:

record - must not be null.

Returns:

he Mono emitting the number of removed records.

delete
```
reactor.core.publisher.Mono<Long> delete(K key,
                                         RecordId... recordIds)
```
Removes the specified records from the stream. Returns the number of records deleted, that may be different from the number of IDs passed in case certain IDs do not exist.

Parameters:

key - the stream key.

recordIds - stream record Id's.

Returns:

the Mono emitting the number of removed records.

See Also:

Redis Documentation: XDEL

createGroup
```
default reactor.core.publisher.Mono<String> createGroup(K key,
                                                        String group)
```
Create a consumer group at the latest offset.

Parameters:

key - the key the stream is stored at.

group - name of the consumer group.

Returns:

the Mono emitting OK if successful.. null when used in pipeline / transaction.

createGroup

reactor.core.publisher.Mono<String> createGroup(K key,
                                                ReadOffset readOffset,
                                                String group)

Create a consumer group.

Parameters:: key - the key the stream is stored at.; readOffset - the ReadOffset to apply.; group - name of the consumer group.
Returns:: the Mono emitting OK if successful.

deleteConsumer
```
reactor.core.publisher.Mono<String> deleteConsumer(K key,
                                                   Consumer consumer)
```
Delete a consumer from a consumer group.

Parameters:

key - the stream key.

consumer - consumer identified by group name and consumer key.

Returns:

the Mono OK if successful. null when used in pipeline / transaction.

destroyGroup
```
reactor.core.publisher.Mono<String> destroyGroup(K key,
                                                 String group)
```
Destroy a consumer group.

Parameters:

key - the stream key.

group - name of the consumer group.

Returns:

the Mono OK if successful. null when used in pipeline / transaction.

size
```
reactor.core.publisher.Mono<Long> size(K key)
```
Get the length of a stream.

Parameters:

key - the stream key.

Returns:

the Mono emitting the length of the stream.

See Also:

Redis Documentation: XLEN

range

default reactor.core.publisher.Flux<MapRecord<K,HK,HV>> range(K key,
                                                              Range<String> range)

Read records from a stream within a specific Range.

Parameters:: key - the stream key.; range - must not be null.
Returns:: the Flux emitting records one by one.
See Also:: Redis Documentation: XRANGE

range

reactor.core.publisher.Flux<MapRecord<K,HK,HV>> range(K key,
                                                      Range<String> range,
                                                      RedisZSetCommands.Limit limit)

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

Parameters:: key - the stream key.; range - must not be null.; limit - must not be null.
Returns:: lthe Flux emitting records one by one.
See Also:: Redis Documentation: XRANGE

range

default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>> range(Class<V> targetType,
                                                                 K key,
                                                                 Range<String> range)

Read all records from a stream within a specific Range.

Parameters:: targetType - the target type of the payload.; key - the stream key.; range - must not be null.
Returns:: the Flux emitting records one by one.
See Also:: Redis Documentation: XRANGE

range

default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>> range(Class<V> targetType,
                                                                 K key,
                                                                 Range<String> range,
                                                                 RedisZSetCommands.Limit limit)

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

Parameters:: targetType - the target type of the payload.; key - the stream key.; range - must not be null.; limit - must not be null.
Returns:: the Flux emitting records one by one.
See Also:: Redis Documentation: XRANGE

read
```
default reactor.core.publisher.Flux<MapRecord<K,HK,HV>> read(StreamOffset<K> stream)
```
Read records from a StreamOffset as ObjectRecord.

Parameters:

stream - the stream to read from.

Returns:

the Flux emitting records one by one.

See Also:

Redis Documentation: XREAD

read

default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>> read(Class<V> targetType,
                                                                StreamOffset<K> stream)

Read records from a StreamOffset as ObjectRecord.

Parameters:: targetType - the target type of the payload.; stream - the stream to read from.
Returns:: the Flux emitting records one by one.
See Also:: Redis Documentation: XREAD

read
```
default reactor.core.publisher.Flux<MapRecord<K,HK,HV>> read(StreamOffset<K>... streams)
```
Read records from one or more StreamOffsets.

Parameters:

streams - the streams to read from.

Returns:

the Flux emitting records one by one.

See Also:

Redis Documentation: XREAD

read

default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>> read(Class<V> targetType,
                                                                StreamOffset<K>... streams)

Read records from one or more StreamOffsets as ObjectRecord.

Parameters:: targetType - the target type of the payload.; streams - the streams to read from.
Returns:: the Flux emitting records one by one.
See Also:: Redis Documentation: XREAD

read

reactor.core.publisher.Flux<MapRecord<K,HK,HV>> read(StreamReadOptions readOptions,
                                                     StreamOffset<K>... streams)

Read records from one or more StreamOffsets.

Parameters:: readOptions - read arguments.; streams - the streams to read from.
Returns:: the Flux emitting records one by one.
See Also:: Redis Documentation: XREAD

read

default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>> read(Class<V> targetType,
                                                                StreamReadOptions readOptions,
                                                                StreamOffset<K>... streams)

Read records from one or more StreamOffsets as ObjectRecord.

Parameters:: targetType - the target type of the payload.; readOptions - read arguments.; streams - the streams to read from.
Returns:: the Flux emitting records one by one.
See Also:: Redis Documentation: XREAD

read

default reactor.core.publisher.Flux<MapRecord<K,HK,HV>> read(Consumer consumer,
                                                             StreamOffset<K>... streams)

Read records from one or more StreamOffsets using a consumer group.

Parameters:: consumer - consumer/group.; streams - the streams to read from.
Returns:: the Flux emitting records one by one.
See Also:: Redis Documentation: XREADGROUP

read

default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>> read(Class<V> targetType,
                                                                Consumer consumer,
                                                                StreamOffset<K>... streams)

Read records from one or more StreamOffsets using a consumer group as ObjectRecord.

Parameters:: targetType - the target type of the payload.; consumer - consumer/group.; streams - the streams to read from.
Returns:: the Flux emitting records one by one.
See Also:: Redis Documentation: XREADGROUP

read

reactor.core.publisher.Flux<MapRecord<K,HK,HV>> read(Consumer consumer,
                                                     StreamReadOptions readOptions,
                                                     StreamOffset<K>... streams)

Read records from one or more StreamOffsets using a consumer group.

Parameters:: consumer - consumer/group.; readOptions - read arguments.; streams - the streams to read from.
Returns:: the Flux emitting records one by one.
See Also:: Redis Documentation: XREADGROUP

read

default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>> read(Class<V> targetType,
                                                                Consumer consumer,
                                                                StreamReadOptions readOptions,
                                                                StreamOffset<K>... streams)

Read records from one or more StreamOffsets using a consumer group as ObjectRecord.

Parameters:: targetType - the target type of the payload.; consumer - consumer/group.; readOptions - read arguments.; streams - the streams to read from.
Returns:: the Flux emitting records one by one.
See Also:: Redis Documentation: XREADGROUP

reverseRange

default reactor.core.publisher.Flux<MapRecord<K,HK,HV>> reverseRange(K key,
                                                                     Range<String> range)

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

Parameters:: key - the stream key.; range - must not be null.
Returns:: the Flux emitting records one by one.
See Also:: Redis Documentation: XREVRANGE

reverseRange

reactor.core.publisher.Flux<MapRecord<K,HK,HV>> reverseRange(K key,
                                                             Range<String> range,
                                                             RedisZSetCommands.Limit limit)

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

Parameters:: key - the stream key.; range - must not be null.; limit - must not be null.
Returns:: the Flux emitting records one by one.
See Also:: Redis Documentation: XREVRANGE

reverseRange

default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>> reverseRange(Class<V> targetType,
                                                                        K key,
                                                                        Range<String> range)

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

Parameters:: targetType - the target type of the payload.; key - the stream key.; range - must not be null.
Returns:: the Flux emitting records one by one.
See Also:: Redis Documentation: XREVRANGE

reverseRange

default <V> reactor.core.publisher.Flux<ObjectRecord<K,V>> reverseRange(Class<V> targetType,
                                                                        K key,
                                                                        Range<String> range,
                                                                        RedisZSetCommands.Limit limit)

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

Parameters:: targetType - the target type of the payload.; key - the stream key.; range - must not be null.; limit - must not be null.
Returns:: the Flux emitting records one by one.
See Also:: Redis Documentation: XREVRANGE

trim
```
reactor.core.publisher.Mono<Long> trim(K key,
                                       long count)
```
Trims the stream to count elements.

Parameters:

key - the stream key.

count - length of the stream.

Returns:

number of removed entries.

See Also:

Redis Documentation: XTRIM

getHashMapper
```
<V> HashMapper<V,HK,HV> getHashMapper(Class<V> targetType)
```
Get the HashMapper for a specific type.

Specified by:

getHashMapper in interface HashMapperProvider<HK,HV>

Type Parameters:

V -

Parameters:

targetType - must not be null.

Returns:

the HashMapper suitable for a given type;

Interface ReactiveStreamOperations<K,HK,HV>

Method Summary

Method Detail

acknowledge

acknowledge

acknowledge

add

add

add

add

delete

delete

delete

createGroup

createGroup

deleteConsumer

destroyGroup

size

range

range

range

range

read

read

read

read

read

read

read

read

read

read

reverseRange

reverseRange

reverseRange

reverseRange

trim

getHashMapper