Class StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K, V extends Record<K,?>>

java.lang.Object

org.springframework.data.redis.stream.StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K,V>

Type Parameters:

K - Stream key and Stream field type

V - Stream value type

Enclosing interface:

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

public static class StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K, V extends Record<K,?>>
extends Object

Builder for StreamMessageListenerContainer.StreamMessageListenerContainerOptions.

Since:

2.2

Author:

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

Method Summary

Modifier and Type	Method	Description
StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K,V>	autoStartup(boolean autoStartup)	Configure the autoStartup to use for the container SmartLifecycle
StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K,V>	batchSize(int messagesPerPoll)	Configure a batch size for the COUNT option during reading.
StreamMessageListenerContainer.StreamMessageListenerContainerOptions<K,V>	build()	Build new StreamMessageListenerContainer.StreamMessageListenerContainerOptions.
StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K,V>	errorHandler(ErrorHandler errorHandler)	Configure a ErrorHandler to be notified on errors.
StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K,V>	executor(Executor executor)	Configure a Executor to run stream polling Tasks.
<HK,HV> StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K, MapRecord<K,HK,HV>>	hashKeySerializer(RedisSerializer<HK> serializer)	Configure a hash key serializer.
<HK,HV> StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K, MapRecord<K,HK,HV>>	hashValueSerializer(RedisSerializer<HV> serializer)	Configure a hash value serializer.
<NK, NV extends Record<NK,?>> StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<NK,NV>	keySerializer(RedisSerializer<NK> serializer)	Configure a key serializer.
<NV> StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K, ObjectRecord<K,NV>>	objectMapper(HashMapper<NV,?,?> hashMapper)	Configure a hash mapper.
StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K,V>	phase(int phase)	Configure the phase to use for the container SmartLifecycle
StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K,V>	pollTimeout(Duration pollTimeout)	Configure a poll timeout for the BLOCK option during reading.
<T> StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<T, MapRecord<T,T,T>>	serializer(RedisSerializer<T> serializer)	Configure a key, hash key and hash value serializer.
<NV> StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K, ObjectRecord<K,NV>>	targetType(Class<NV> targetType)	Configure a hash target type.

Methods inherited from class Object

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

Method Details

pollTimeout

public StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K,V> pollTimeout(Duration pollTimeout)

Configure a poll timeout for the BLOCK option during reading.

Parameters:

pollTimeout - must not be null or negative.

Returns:

this StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder.

batchSize

public StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K,V> batchSize(int messagesPerPoll)

Configure a batch size for the COUNT option during reading.

Parameters:

messagesPerPoll - must not be greater zero.

Returns:

this StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder.

executor

public StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K,V> executor(Executor executor)

Configure a Executor to run stream polling Tasks.

Parameters:

executor - must not be null.

Returns:

this StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder.

errorHandler

public StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K,V> errorHandler(ErrorHandler errorHandler)

Configure a ErrorHandler to be notified on errors.

Parameters:

errorHandler - must not be null.

Returns:

this StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder.

phase

public StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K,V> phase(int phase)

Configure the phase to use for the container SmartLifecycle

Returns:

this StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder.

Since:

4.0

autoStartup

public StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K,V> autoStartup(boolean autoStartup)

Configure the autoStartup to use for the container SmartLifecycle

Returns:

this StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder.

Since:

4.0

serializer

public <T>
StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<T, MapRecord<T,T,T>> serializer(RedisSerializer<T> serializer)

Configure a key, hash key and hash value serializer.

Parameters:

serializer - must not be null.

Returns:

this StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder.

keySerializer

public <NK, NV extends Record<NK,?>>
StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<NK,NV> keySerializer(RedisSerializer<NK> serializer)

Configure a key serializer.

Parameters:

serializer - must not be null.

Returns:

this StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder.

hashKeySerializer

public <HK,HV>
StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K, MapRecord<K,HK,HV>> hashKeySerializer(RedisSerializer<HK> serializer)

Configure a hash key serializer.

Parameters:

serializer - must not be null.

Returns:

this StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder.

hashValueSerializer

public <HK,HV>
StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K, MapRecord<K,HK,HV>> hashValueSerializer(RedisSerializer<HV> serializer)

Configure a hash value serializer.

Parameters:

serializer - must not be null.

Returns:

this StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder.

targetType

public <NV>
StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K, ObjectRecord<K,NV>> targetType(Class<NV> targetType)

Configure a hash target type. Changes the emitted Record type to ObjectRecord.

Parameters:

targetType - must not be null.

Returns:

this StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder.

objectMapper

public <NV>
StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<K, ObjectRecord<K,NV>> objectMapper(HashMapper<NV,?,?> hashMapper)

Configure a hash mapper. Changes the emitted Record type to ObjectRecord.

Parameters:

hashMapper - must not be null.

Returns:

this StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder.

build

public StreamMessageListenerContainer.StreamMessageListenerContainerOptions<K,V> build()

Build new StreamMessageListenerContainer.StreamMessageListenerContainerOptions.

Returns:

new StreamMessageListenerContainer.StreamMessageListenerContainerOptions.