Class StreamMessageListenerContainer.StreamReadRequestBuilder<K>

java.lang.Object

org.springframework.data.redis.stream.StreamMessageListenerContainer.StreamReadRequestBuilder<K>

Type Parameters:

K - Stream key and Stream field type.

Direct Known Subclasses:

StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder

Enclosing interface:

StreamMessageListenerContainer<K, V extends Record<K,?>>

public static class StreamMessageListenerContainer.StreamReadRequestBuilder<K>
extends Object

Builder to build a StreamMessageListenerContainer.StreamReadRequest.

Since:

2.2

Author:

Mark Paluch, Christoph Strobl, Christian Rest, DongCheol Kim, Su Ko

Method Summary

Modifier and Type	Method	Description
StreamMessageListenerContainer.StreamReadRequest<K>	build()	Build a new instance of StreamMessageListenerContainer.StreamReadRequest.
StreamMessageListenerContainer.StreamReadRequestBuilder<K>	cancelOnError(Predicate<Throwable> cancelSubscriptionOnError)	Configure a cancellation Predicate to be notified on errors.
StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder<K>	consumer(Consumer consumer)	Configure a Consumer to consume stream messages within a consumer group.
StreamMessageListenerContainer.StreamReadRequestBuilder<K>	errorHandler(ErrorHandler errorHandler)	Configure a ErrorHandler to be notified on errors.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

errorHandler

public StreamMessageListenerContainer.StreamReadRequestBuilder<K> errorHandler(ErrorHandler errorHandler)

Configure a ErrorHandler to be notified on errors.

Parameters:

errorHandler - must not be null.

Returns:

this StreamMessageListenerContainer.StreamReadRequestBuilder.

cancelOnError

public StreamMessageListenerContainer.StreamReadRequestBuilder<K> cancelOnError(Predicate<Throwable> cancelSubscriptionOnError)

Configure a cancellation Predicate to be notified on errors. The outcome of the Predicate decides whether to cancel the subscription by returning true.

Parameters:

cancelSubscriptionOnError - must not be null.

Returns:

this StreamMessageListenerContainer.StreamReadRequestBuilder.

consumer

public StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder<K> consumer(Consumer consumer)

Configure a Consumer to consume stream messages within a consumer group.

Parameters:

consumer - must not be null.

Returns:

a new StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder.

build

public StreamMessageListenerContainer.StreamReadRequest<K> build()

Build a new instance of StreamMessageListenerContainer.StreamReadRequest.

Returns:

a new instance of StreamMessageListenerContainer.StreamReadRequest.