StreamReceiver.StreamReceiverOptionsBuilder (Spring Data Redis 2.4.0-M1 API)

java.lang.Object
- org.springframework.data.redis.stream.StreamReceiver.StreamReceiverOptionsBuilder<K,V>

Type Parameters:

K - Stream key and Stream field type.

Enclosing interface:

StreamReceiver<K,V extends Record<K,?>>
```
public static class StreamReceiver.StreamReceiverOptionsBuilder<K,V extends Record<K,?>>
extends Object
```
Builder for StreamReceiver.StreamReceiverOptions.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StreamReceiver.StreamReceiverOptionsBuilder<K,V>`	`batchSize(int recordsPerPoll)` Configure a batch size for the `COUNT` option during reading.
`StreamReceiver.StreamReceiverOptions<K,V>`	`build()` Build new `StreamReceiver.StreamReceiverOptions`.
`<HK,HV> StreamReceiver.StreamReceiverOptionsBuilder<K,MapRecord<K,HK,HV>>`	`hashKeySerializer(RedisSerializationContext.SerializationPair<HK> pair)` Configure a hash key serializer.
`<HK,HV> StreamReceiver.StreamReceiverOptionsBuilder<K,MapRecord<K,HK,HV>>`	`hashValueSerializer(RedisSerializationContext.SerializationPair<HK> pair)` Configure a hash value serializer.
`<NK,NV extends Record<NK,?>> StreamReceiver.StreamReceiverOptionsBuilder<NK,NV>`	`keySerializer(RedisSerializationContext.SerializationPair<NK> pair)` Configure a key serializer.
`<NV> StreamReceiver.StreamReceiverOptionsBuilder<K,ObjectRecord<K,NV>>`	`objectMapper(HashMapper<NV,?,?> hashMapper)` Configure a hash mapper.
`StreamReceiver.StreamReceiverOptionsBuilder<K,V>`	`pollTimeout(Duration pollTimeout)` Configure a poll timeout for the `BLOCK` option during reading.
`<T> StreamReceiver.StreamReceiverOptionsBuilder<T,MapRecord<T,T,T>>`	`serializer(RedisSerializationContext.SerializationPair<T> pair)` Configure a key, hash key and hash value serializer.
`<T> StreamReceiver.StreamReceiverOptionsBuilder<T,MapRecord<T,T,T>>`	`serializer(RedisSerializationContext<T,?> serializationContext)` Configure a key, hash key and hash value serializer.
`<NV> StreamReceiver.StreamReceiverOptionsBuilder<K,ObjectRecord<K,NV>>`	`targetType(Class<NV> targetType)` Configure a hash target type.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - pollTimeout
```
public StreamReceiver.StreamReceiverOptionsBuilder<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 StreamReceiver.StreamReceiverOptionsBuilder.
  - batchSize
```
public StreamReceiver.StreamReceiverOptionsBuilder<K,V> batchSize(int recordsPerPoll)
```
    Configure a batch size for the COUNT option during reading.
    
    Parameters:
    
    recordsPerPoll - must not be greater zero.
    
    Returns:
    
    this StreamReceiver.StreamReceiverOptionsBuilder.
  - serializer
```
public <T> StreamReceiver.StreamReceiverOptionsBuilder<T,MapRecord<T,T,T>> serializer(RedisSerializationContext.SerializationPair<T> pair)
```
    Configure a key, hash key and hash value serializer.
    
    Parameters:
    
    pair - must not be null.
    
    Returns:
    
    this StreamReceiver.StreamReceiverOptionsBuilder.
  - serializer
```
public <T> StreamReceiver.StreamReceiverOptionsBuilder<T,MapRecord<T,T,T>> serializer(RedisSerializationContext<T,?> serializationContext)
```
    Configure a key, hash key and hash value serializer.
    
    Parameters:
    
    serializationContext - must not be null.
    
    Returns:
    
    this StreamReceiver.StreamReceiverOptionsBuilder.
  - keySerializer
```
public <NK,NV extends Record<NK,?>> StreamReceiver.StreamReceiverOptionsBuilder<NK,NV> keySerializer(RedisSerializationContext.SerializationPair<NK> pair)
```
    Configure a key serializer.
    
    Parameters:
    
    pair - must not be null.
    
    Returns:
    
    this StreamReceiver.StreamReceiverOptionsBuilder.
  - hashKeySerializer
```
public <HK,HV> StreamReceiver.StreamReceiverOptionsBuilder<K,MapRecord<K,HK,HV>> hashKeySerializer(RedisSerializationContext.SerializationPair<HK> pair)
```
    Configure a hash key serializer.
    
    Parameters:
    
    pair - must not be null.
    
    Returns:
    
    this StreamReceiver.StreamReceiverOptionsBuilder.
  - hashValueSerializer
```
public <HK,HV> StreamReceiver.StreamReceiverOptionsBuilder<K,MapRecord<K,HK,HV>> hashValueSerializer(RedisSerializationContext.SerializationPair<HK> pair)
```
    Configure a hash value serializer.
    
    Parameters:
    
    pair - must not be null.
    
    Returns:
    
    this StreamReceiver.StreamReceiverOptionsBuilder.
  - targetType
```
public <NV> StreamReceiver.StreamReceiverOptionsBuilder<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 StreamReceiver.StreamReceiverOptionsBuilder.
  - objectMapper
```
public <NV> StreamReceiver.StreamReceiverOptionsBuilder<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 StreamReceiver.StreamReceiverOptionsBuilder.
  - build
```
public StreamReceiver.StreamReceiverOptions<K,V> build()
```
    Build new StreamReceiver.StreamReceiverOptions.
    
    Returns:
    
    new StreamReceiver.StreamReceiverOptions.

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

pollTimeout

batchSize

serializer

serializer

keySerializer

hashKeySerializer

hashValueSerializer

targetType

objectMapper

build