Class StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder<K>
java.lang.Object
org.springframework.data.redis.stream.StreamMessageListenerContainer.StreamReadRequestBuilder<K>
org.springframework.data.redis.stream.StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder<K>
- Type Parameters:
K
- Stream key and Stream field type.
- Enclosing interface:
- StreamMessageListenerContainer<K,
V extends Record<K, ?>>
public static class StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder<K>
extends StreamMessageListenerContainer.StreamReadRequestBuilder<K>
Builder to build a
StreamMessageListenerContainer.ConsumerStreamReadRequest
.-
Method Summary
Modifier and TypeMethodDescriptionautoAcknowledge
(boolean autoAck) Configure auto-acknowledgement for stream message consumption.build()
Build a new instance ofStreamMessageListenerContainer.ConsumerStreamReadRequest
.cancelOnError
(Predicate<Throwable> cancelSubscriptionOnError) Configure a cancellationPredicate
to be notified onread, deserialization, and listener errors
.Configure aConsumer
to consume stream messages within a consumer group.errorHandler
(ErrorHandler errorHandler) Configure aErrorHandler
to be notified onread, deserialization, and listener errors
.
-
Method Details
-
errorHandler
public StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder<K> errorHandler(ErrorHandler errorHandler) Configure aErrorHandler
to be notified onread, deserialization, and listener errors
.- Overrides:
errorHandler
in classStreamMessageListenerContainer.StreamReadRequestBuilder<K>
- Parameters:
errorHandler
- must not be null.- Returns:
this
StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder
.
-
cancelOnError
public StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder<K> cancelOnError(Predicate<Throwable> cancelSubscriptionOnError) Configure a cancellationPredicate
to be notified onread, deserialization, and listener errors
. The outcome of thePredicate
decides whether to cancel the subscription by returning true.- Overrides:
cancelOnError
in classStreamMessageListenerContainer.StreamReadRequestBuilder<K>
- Parameters:
cancelSubscriptionOnError
- must not be null.- Returns:
this
StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder
.
-
consumer
public StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder<K> consumer(Consumer consumer) Configure aConsumer
to consume stream messages within a consumer group.- Overrides:
consumer
in classStreamMessageListenerContainer.StreamReadRequestBuilder<K>
- Parameters:
consumer
- must not be null.- Returns:
this
StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder
.
-
autoAcknowledge
public StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder<K> autoAcknowledge(boolean autoAck) Configure auto-acknowledgement for stream message consumption.- Parameters:
autoAck
- true (default) to auto-acknowledge received messages or false for external acknowledgement.- Returns:
this
StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder
.- Since:
- 2.3
-
build
Build a new instance ofStreamMessageListenerContainer.ConsumerStreamReadRequest
.- Overrides:
build
in classStreamMessageListenerContainer.StreamReadRequestBuilder<K>
- Returns:
- a new instance of
StreamMessageListenerContainer.ConsumerStreamReadRequest
.
-