org.springframework.data.redis.stream

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 Type	Method and Description
StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder<K>	autoAck(boolean autoAck) Deprecated. since 2.3, use autoAcknowledge(boolean) instead.
StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder<K>	autoAcknowledge(boolean autoAck) Configure auto-acknowledgement for stream message consumption.
StreamMessageListenerContainer.ConsumerStreamReadRequest<K>	build() Build a new instance of StreamMessageListenerContainer.ConsumerStreamReadRequest.
StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder<K>	cancelOnError(Predicate<Throwable> cancelSubscriptionOnError) Configure a cancellation Predicate to be notified on read, deserialization, and listener errors.
StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder<K>	consumer(Consumer consumer) Configure a Consumer to consume stream messages within a consumer group.
StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder<K>	errorHandler(ErrorHandler errorHandler) Configure a ErrorHandler to be notified on read, deserialization, and listener errors.

Methods inherited from class java.lang.Object

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

Method Detail

errorHandler

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

Configure a ErrorHandler to be notified on read, deserialization, and listener errors.

Overrides:

errorHandler in class StreamMessageListenerContainer.StreamReadRequestBuilder<K>

Parameters:

errorHandler - must not be null.

Returns:

this StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder.

cancelOnError

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

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

Overrides:

cancelOnError in class StreamMessageListenerContainer.StreamReadRequestBuilder<K>

Parameters:

cancelSubscriptionOnError - must not be null.

Returns:

this StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder.

consumer

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

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

Overrides:

consumer in class StreamMessageListenerContainer.StreamReadRequestBuilder<K>

Parameters:

consumer - must not be null.

Returns:

this StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder.

autoAck

@Deprecated
public StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder<K> autoAck(boolean autoAck)

Deprecated. since 2.3, use autoAcknowledge(boolean) instead.

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.

autoAcknowledge

public StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder<K> autoAcknowledge(boolean autoAck)

Configure auto-acknowledgement for stream message consumption. This method is an alias for autoAck(boolean) for improved readability.

Parameters:

autoAck - true (default) to auto-acknowledge received messages or false for external acknowledgement.

Returns:

this StreamMessageListenerContainer.ConsumerStreamReadRequestBuilder.

Since:

2.3

build

public StreamMessageListenerContainer.ConsumerStreamReadRequest<K> build()

Build a new instance of StreamMessageListenerContainer.ConsumerStreamReadRequest.

Overrides:

build in class StreamMessageListenerContainer.StreamReadRequestBuilder<K>

Returns:

a new instance of StreamMessageListenerContainer.ConsumerStreamReadRequest.