Class StreamReceiver.StreamReceiverOptions<K, V extends Record<K,?>>

java.lang.Object

org.springframework.data.redis.stream.StreamReceiver.StreamReceiverOptions<K,V>

Type Parameters:

K - Stream key and Stream field type.

V - Stream value type.

Enclosing interface:

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

public static class StreamReceiver.StreamReceiverOptions<K, V extends Record<K,?>>
extends Object

Options for StreamReceiver.

Since:

2.2

Author:

Mark Paluch, Eddie McDaniel

See Also:

• StreamReceiver.StreamReceiverOptionsBuilder

Method Summary

Modifier and Type	Method	Description
static StreamReceiver.StreamReceiverOptionsBuilder<String, MapRecord<String,String,String>>	builder()
static <T> StreamReceiver.StreamReceiverOptionsBuilder<String, ObjectRecord<String,T>>	builder(HashMapper<T,byte[],byte[]> hashMapper)
OptionalInt	getBatchSize()	Batch size polling using the COUNT option during reads.
RedisSerializationContext.SerializationPair<Object>	getHashKeySerializer()
@Nullable HashMapper<Object,Object,Object>	getHashMapper()
RedisSerializationContext.SerializationPair<Object>	getHashValueSerializer()
RedisSerializationContext.SerializationPair<K>	getKeySerializer()
Duration	getPollTimeout()	Timeout for blocking polling using the BLOCK option during reads.
HashMapper<Object,Object,Object>	getRequiredHashMapper()
Function<? super Throwable, ? extends Publisher<Void>>	getResumeFunction()
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 StreamReceiver.StreamReceiverOptionsBuilder<String, MapRecord<String,String,String>> builder()

Returns:

a new builder for StreamReceiver.StreamReceiverOptions.

builder

public static <T>
StreamReceiver.StreamReceiverOptionsBuilder<String, ObjectRecord<String,T>> builder(HashMapper<T,byte[],byte[]> hashMapper)

Returns:

a new builder for StreamReceiver.StreamReceiverOptions.

getPollTimeout

public Duration getPollTimeout()

Timeout for blocking polling using the BLOCK option during reads.

Returns:

the actual timeout.

getBatchSize

public OptionalInt getBatchSize()

Batch size polling using the COUNT option during reads.

Returns:

the batch size.

getResumeFunction

public Function<? super Throwable, ? extends Publisher<Void>> getResumeFunction()

getKeySerializer

public RedisSerializationContext.SerializationPair<K> getKeySerializer()

getHashKeySerializer

public RedisSerializationContext.SerializationPair<Object> getHashKeySerializer()

getHashValueSerializer

public RedisSerializationContext.SerializationPair<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()