Module spring.data.redis

Package org.springframework.data.redis.stream

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.

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()
HashMapper<Object,Object,Object>	getHashMapper()
RedisSerializer<Object>	getHashValueSerializer()
RedisSerializer<K>	getKeySerializer()
Duration	getPollTimeout()	Timeout for blocking polling using the BLOCK option during reads.
HashMapper<Object,Object,Object>	getRequiredHashMapper()
Class<Object>	getTargetType()
boolean	hasHashMapper()

Methods inherited from class java.lang.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

@Nullable
public 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.