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

java.lang.Object

org.springframework.data.redis.stream.StreamMessageListenerContainer.StreamMessageListenerContainerOptions<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.StreamMessageListenerContainerOptions<K, V extends Record<K,?>>
extends Object

Options for StreamMessageListenerContainer.

Since:

2.2

Author:

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

See Also:

• StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder

Method Summary

Modifier and Type	Method	Description
static StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<String, MapRecord<String,String,String>>	builder()
OptionalInt	getBatchSize()	Batch size polling using the COUNT option during reads.
ErrorHandler	getErrorHandler()
Executor	getExecutor()
RedisSerializer<Object>	getHashKeySerializer()
@Nullable HashMapper<Object,Object,Object>	getHashMapper()
RedisSerializer<Object>	getHashValueSerializer()
RedisSerializer<K>	getKeySerializer()
OptionalInt	getPhase()
Duration	getPollTimeout()	Timeout for blocking polling using the BLOCK option during reads.
HashMapper<Object,Object,Object>	getRequiredHashMapper()
Class<Object>	getTargetType()
boolean	hasHashMapper()
Optional<Boolean>	isAutoStartup()

Methods inherited from class Object

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

Method Details

builder

public static StreamMessageListenerContainer.StreamMessageListenerContainerOptionsBuilder<String, MapRecord<String,String,String>> builder()

Returns:

a new builder for StreamMessageListenerContainer.StreamMessageListenerContainerOptions.

getPollTimeout

public Duration getPollTimeout()

Timeout for blocking polling using the BLOCK option during reads.

Returns:

the timeout.

getBatchSize

public OptionalInt getBatchSize()

Batch size polling using the COUNT option during reads.

Returns:

the batch size.

getKeySerializer

public RedisSerializer<K> getKeySerializer()

getHashKeySerializer

public RedisSerializer<Object> getHashKeySerializer()

getHashValueSerializer

public RedisSerializer<Object> getHashValueSerializer()

getHashMapper

public @Nullable HashMapper<Object,Object,Object> getHashMapper()

getRequiredHashMapper

public HashMapper<Object,Object,Object> getRequiredHashMapper()

hasHashMapper

public boolean hasHashMapper()

getTargetType

public Class<Object> getTargetType()

getErrorHandler

public ErrorHandler getErrorHandler()

Returns:

the default ErrorHandler.

getExecutor

public Executor getExecutor()

Returns:

the Executor to run stream polling Tasks. Defaults to SimpleAsyncTaskExecutor.

getPhase

public OptionalInt getPhase()

Returns:

the configured phase to use for the container lifecycle or empty if the phase was not specified on the options.

Since:

4.0

isAutoStartup

public Optional<Boolean> isAutoStartup()

Returns:

the configured autoStartup to use for the container lifecycle or empty if the autoStartup was not specified on the options.

Since:

4.0