Interface ReactiveStreamOperations<K,HK,HV>

All Superinterfaces:
HashMapperProvider<HK,HV>
@NullUnmarked public interface ReactiveStreamOperations<K,HK,HV> extends HashMapperProvider<HK,HV>
Reactive Redis operations for Stream Commands.
Since:
2.2
Author:
Mark Paluch, Christoph Strobl, Dengliming, Marcin Zielinski, John Blum, jinkshower

  • Method Details

    • acknowledge

      default Mono<Long> acknowledge(@NonNull K key, @NonNull String group, @NonNull String @NonNull ... 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:

    • acknowledge

      Mono<Long> acknowledge(@NonNull K key, @NonNull String group, @NonNull RecordId @NonNull ... 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:

    • acknowledge

      default Mono<Long> acknowledge(@NonNull String group, @NonNull 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:

    • add

      default Mono<RecordId> add(@NonNull K key, @NonNull Map<? extends HK, ? extends HV> content, @NonNull RedisStreamCommands.XAddOptions xAddOptions)
      Append a record to the stream key with the specified options.
      Parameters:
      key - the stream key.
      content - record content as Map.
      xAddOptions - parameters for the XADD call.
      Returns:
      the Mono emitting the RecordId.
      Since:
      3.4
      See Also:

    • add

      default Mono<RecordId> add(@NonNull MapRecord<K, ? extends HK, ? extends HV> record, @NonNull RedisStreamCommands.XAddOptions xAddOptions)
      Append a record, backed by a Map holding the field/value pairs, to the stream with the specified options.
      Parameters:
      record - the record to append.
      xAddOptions - parameters for the XADD call.
      Returns:
      the Mono emitting the RecordId.
      Since:
      3.4
      See Also:

    • add

      Mono<RecordId> add(@NonNull Record<K,?> record, @NonNull RedisStreamCommands.XAddOptions xAddOptions)
      Append the record, backed by the given value, to the stream with the specified options. The value will be hashed and serialized.
      Parameters:
      record - must not be null.
      xAddOptions - parameters for the XADD call. Must not be null.
      Returns:
      the Mono emitting the RecordId.
      Since:
      3.4
      See Also:

    • add

      default Flux<RecordId> add(@NonNull K key, @NonNull 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:

    • add

      default Mono<RecordId> add(@NonNull K key, @NonNull 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:

    • add

      default Mono<RecordId> add(@NonNull 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:

    • add

      Mono<RecordId> add(@NonNull 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:

    • claim

      default Flux<MapRecord<K,HK,HV>> claim(@NonNull K key, @NonNull String consumerGroup, @NonNull String newOwner, @NonNull Duration minIdleTime, @NonNull RecordId @NonNull ... recordIds)
      Changes the ownership of a pending message so that the new owner is the consumer specified as the command argument. The message is claimed only if its idle time (ms) is greater than the minimum idle time specified when calling XCLAIM.
      Parameters:
      key - key to the steam.
      consumerGroup - name of the consumer group.
      newOwner - name of the consumer claiming the message.
      minIdleTime - minimum idle time required for a message to be claimed.
      recordIds - record IDs to be claimed.
      Returns:
      Flux of claimed MapRecords.
      See Also:

    • claim

      Flux<MapRecord<K,HK,HV>> claim(@NonNull K key, @NonNull String consumerGroup, @NonNull String newOwner, @NonNull RedisStreamCommands.XClaimOptions xClaimOptions)
      Changes the ownership of a pending message so that the new owner is the consumer specified as the command argument. The message is claimed only if its idle time (ms) is greater than the given minimum idle time specified when calling XCLAIM.
      Parameters:
      key - key to the steam.
      consumerGroup - name of the consumer group.
      newOwner - name of the consumer claiming the message.
      xClaimOptions - additional parameters for the CLAIM call.
      Returns:
      a Flux of claimed MapRecords.
      See Also:

    • delete

      default Mono<Long> delete(@NonNull K key, @NonNull String @NonNull ... 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:

    • delete

      default Mono<Long> delete(@NonNull 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

      Mono<Long> delete(@NonNull K key, @NonNull RecordId @NonNull ... 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:

    • createGroup

      default Mono<String> createGroup(@NonNull K key, @NonNull String group)
      Create a consumer group at the latest offset. This command creates the stream if it does not already exist.
      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

      Mono<String> createGroup(@NonNull K key, @NonNull ReadOffset readOffset, @NonNull String group)
      Create a consumer group. This command creates the stream if it does not already exist.
      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

      Mono<String> deleteConsumer(@NonNull K key, @NonNull 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

      Mono<String> destroyGroup(@NonNull K key, @NonNull 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.

    • consumers

      Flux<StreamInfo.XInfoConsumer> consumers(@NonNull K key, @NonNull String group)
      Obtain information about every consumer in a specific consumer group for the stream stored at the specified key.
      Parameters:
      key - the key the stream is stored at.
      group - name of the consumer group.
      Returns:
      null when used in pipeline / transaction.
      Since:
      2.3

    • groups

      Flux<StreamInfo.XInfoGroup> groups(@NonNull K key)
      Obtain information about consumer groups associated with the stream stored at the specified key.
      Parameters:
      key - the key the stream is stored at.
      Returns:
      null when used in pipeline / transaction.
      Since:
      2.3

    • info

      Mono<StreamInfo.XInfoStream> info(@NonNull K key)
      Obtain general information about the stream stored at the specified key.
      Parameters:
      key - the key the stream is stored at.
      Returns:
      null when used in pipeline / transaction.
      Since:
      2.3

    • pending

      Mono<PendingMessagesSummary> pending(@NonNull K key, @NonNull String group)
      Obtain the PendingMessagesSummary for a given consumer group.
      Parameters:
      key - the key the stream is stored at. Must not be null.
      group - the name of the consumer group. Must not be null.
      Returns:
      a summary of pending messages within the given consumer group or null when used in pipeline / transaction.
      Since:
      2.3
      See Also:

    • pending

      default Mono<PendingMessages> pending(@NonNull K key, @NonNull Consumer consumer)
      Obtained detailed information about all pending messages for a given Consumer.
      Parameters:
      key - the key the stream is stored at. Must not be null.
      consumer - the consumer to fetch PendingMessages for. Must not be null.
      Returns:
      pending messages for the given Consumer or null when used in pipeline / transaction.
      Since:
      2.3
      See Also:

    • pending

      Mono<PendingMessages> pending(@NonNull K key, @NonNull String group, @NonNull Range<?> range, long count)
      Obtain detailed information about pending messages for a given Range within a consumer group.
      Parameters:
      key - the key the stream is stored at. Must not be null.
      group - the name of the consumer group. Must not be null.
      range - the range of messages ids to search within. Must not be null.
      count - limit the number of results.
      Returns:
      pending messages for the given consumer group or null when used in pipeline / transaction.
      Since:
      2.3
      See Also:

    • pending

      Mono<PendingMessages> pending(@NonNull K key, @NonNull Consumer consumer, @NonNull Range<?> range, long count)
      Obtain detailed information about pending messages for a given Range and Consumer within a consumer group.
      Parameters:
      key - the key the stream is stored at. Must not be null.
      consumer - the name of the Consumer. Must not be null.
      range - the range of messages ids to search within. Must not be null.
      count - limit the number of results.
      Returns:
      pending messages for the given Consumer or null when used in pipeline / transaction.
      Since:
      2.3
      See Also:

    • size

      Mono<Long> size(@NonNull K key)
      Get the length of a stream.
      Parameters:
      key - the stream key.
      Returns:
      the Mono emitting the length of the stream.
      See Also:

    • range

      default Flux<MapRecord<K,HK,HV>> range(@NonNull K key, @NonNull 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:

    • range

      Flux<MapRecord<K,HK,HV>> range(@NonNull K key, @NonNull Range<String> range, @NonNull Limit limit)
      Read records from a stream within a specific Range applying a 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:

    • range

      default <V> Flux<ObjectRecord<K,V>> range(@NonNull Class<V> targetType, @NonNull K key, @NonNull 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:

    • range

      default <V> Flux<ObjectRecord<K,V>> range(@NonNull Class<V> targetType, @NonNull K key, @NonNull Range<String> range, @NonNull Limit limit)
      Read records from a stream within a specific Range applying a 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:

    • read

      default Flux<MapRecord<K,HK,HV>> read(@NonNull 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:

    • read

      default <V> Flux<ObjectRecord<K,V>> read(@NonNull Class<V> targetType, @NonNull 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:

    • read

      default Flux<MapRecord<K,HK,HV>> read(@NonNull 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:

    • read

      default <V> Flux<ObjectRecord<K,V>> read(@NonNull Class<V> targetType, @NonNull 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:

    • read

      Flux<MapRecord<K,HK,HV>> read(@NonNull StreamReadOptions readOptions, @NonNull StreamOffset<K> @NonNull ... 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:

    • read

      default <V> Flux<ObjectRecord<K,V>> read(@NonNull Class<V> targetType, @NonNull StreamReadOptions readOptions, @NonNull StreamOffset<K> @NonNull ... 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:

    • read

      default Flux<MapRecord<K,HK,HV>> read(@NonNull Consumer consumer, @NonNull StreamOffset<K> @NonNull ... 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:

    • read

      default <V> Flux<ObjectRecord<K,V>> read(@NonNull Class<V> targetType, @NonNull Consumer consumer, @NonNull StreamOffset<K> @NonNull ... 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:

    • read

      Flux<MapRecord<K,HK,HV>> read(@NonNull Consumer consumer, @NonNull StreamReadOptions readOptions, @NonNull 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:

    • read

      default <V> Flux<ObjectRecord<K,V>> read(@NonNull Class<V> targetType, @NonNull Consumer consumer, @NonNull StreamReadOptions readOptions, @NonNull StreamOffset<K> @NonNull ... 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:

    • reverseRange

      default Flux<MapRecord<K,HK,HV>> reverseRange(@NonNull K key, @NonNull 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:

    • reverseRange

      Flux<MapRecord<K,HK,HV>> reverseRange(@NonNull K key, @NonNull Range<String> range, @NonNull Limit limit)
      Read records from a stream within a specific Range applying a 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:

    • reverseRange

      default <V> Flux<ObjectRecord<K,V>> reverseRange(@NonNull Class<V> targetType, @NonNull K key, @NonNull 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:

    • reverseRange

      default <V> Flux<ObjectRecord<K,V>> reverseRange(@NonNull Class<V> targetType, @NonNull K key, @NonNull Range<String> range, @NonNull Limit limit)
      Read records from a stream within a specific Range applying a 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:

    • trim

      Mono<Long> trim(@NonNull 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:

    • trim

      Mono<Long> trim(@NonNull K key, long count, boolean approximateTrimming)
      Trims the stream to count elements.
      Parameters:
      key - the stream key.
      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.
      Since:
      2.4
      See Also:

    • getHashMapper

      <V> HashMapper<V,HK,HV> getHashMapper(@NonNull Class<V> targetType)
      Get the HashMapper for a specific type.
      Specified by:
      getHashMapper in interface HashMapperProvider<K,HK>
      Type Parameters:
      V -
      Parameters:
      targetType - must not be null.
      Returns:
      the HashMapper suitable for a given type;

    • map

      default <V> ObjectRecord<K,V> map(@NonNull MapRecord<K,HK,HV> record, @NonNull Class<V> targetType)
      Map records from MapRecord to ObjectRecord.
      Parameters:
      record - the stream records to map.
      targetType - the target type of the payload.
      Returns:
      the mapped ObjectRecord.
      Since:
      2.x

    • deserializeRecord

      MapRecord<K,HK,HV> deserializeRecord(@NonNull ByteBufferRecord record)
      Deserialize a ByteBufferRecord using the configured serialization context into a MapRecord.
      Parameters:
      record - the stream record to map.
      Returns:
      deserialized MapRecord.
      Since:
      2.x