Package org.springframework.integration.redis.dsl

Class RedisStreamInboundChannelAdapterSpec

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<S,P>

org.springframework.integration.dsl.MessageProducerSpec<RedisStreamInboundChannelAdapterSpec,ReactiveRedisStreamMessageProducer>

org.springframework.integration.redis.dsl.RedisStreamInboundChannelAdapterSpec

All Implemented Interfaces:

DisposableBean, FactoryBean<ReactiveRedisStreamMessageProducer>, InitializingBean, Lifecycle, Phased, SmartLifecycle

public class RedisStreamInboundChannelAdapterSpec
extends MessageProducerSpec<RedisStreamInboundChannelAdapterSpec,ReactiveRedisStreamMessageProducer>

A MessageProducerSpec for a ReactiveRedisStreamMessageProducer.

Since:

7.1

Author:

Jiandong Ma

Field Summary

Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

logger, PARSER, target

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RedisStreamInboundChannelAdapterSpec(ReactiveRedisConnectionFactory connectionFactory, String streamKey)

Method Summary

Modifier and Type	Method	Description
RedisStreamInboundChannelAdapterSpec	autoAck(boolean autoAck)	Specify whether acknowledge message read in the Consumer Group.
RedisStreamInboundChannelAdapterSpec	batchSize(int recordsPerPoll)	Specify the batch size for the COUNT option.
RedisStreamInboundChannelAdapterSpec	consumerGroup(String consumerGroup)	Specify the name of the consumer group.
RedisStreamInboundChannelAdapterSpec	consumerName(@Nullable String consumerName)	Specify the name of the consumer.
RedisStreamInboundChannelAdapterSpec	createConsumerGroup(boolean createConsumerGroup)	Specify whether create the consumer group.
RedisStreamInboundChannelAdapterSpec	errorResumeFunction(Function<? super Throwable,? extends org.reactivestreams.Publisher<Void>> resumeFunction)	Specify the resume Function when polling the stream fails.
RedisStreamInboundChannelAdapterSpec	extractPayload(boolean extractPayload)	Specify whether extract payload.
RedisStreamInboundChannelAdapterSpec	objectMapper(HashMapper<?,?,?> hashMapper)	Specify the hashMapper.
RedisStreamInboundChannelAdapterSpec	pollTimeout(Duration pollTimeout)	Specify the poll timeout for the BLOCK option.
RedisStreamInboundChannelAdapterSpec	readOffset(ReadOffset readOffset)	Specify the offset from which to read message.
RedisStreamInboundChannelAdapterSpec	serializer(RedisSerializationContext.SerializationPair<?> pair)	Specify the key, hash key and hash value serializer.
RedisStreamInboundChannelAdapterSpec	streamReceiverOptions(@Nullable StreamReceiver.StreamReceiverOptions<String,?> streamReceiverOptions)	Specify the streamReceiverOptions to customize the StreamReceiver.
RedisStreamInboundChannelAdapterSpec	targetType(Class<?> targetType)	Specify the hash target type.

Methods inherited from class org.springframework.integration.dsl.MessageProducerSpec

autoStartup, errorChannel, errorChannel, errorMessageStrategy, id, observationConvention, outputChannel, outputChannel, phase, role, sendTimeout, shouldTrack

Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

_this, afterPropertiesSet, destroy, doGet, getId, getObject, getObjectType, getPhase, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.FactoryBean

isSingleton

Methods inherited from interface org.springframework.context.SmartLifecycle

isPauseable

Constructor Details

RedisStreamInboundChannelAdapterSpec

protected RedisStreamInboundChannelAdapterSpec(ReactiveRedisConnectionFactory connectionFactory,
 String streamKey)

Method Details

readOffset

public RedisStreamInboundChannelAdapterSpec readOffset(ReadOffset readOffset)

Specify the offset from which to read message.

Parameters:

readOffset - the readOffset

Returns:

the spec

See Also:

• ReactiveRedisStreamMessageProducer.setReadOffset(ReadOffset)

extractPayload

public RedisStreamInboundChannelAdapterSpec extractPayload(boolean extractPayload)

Specify whether extract payload.

Parameters:

extractPayload - the extractPayload

Returns:

the spec

See Also:

• ReactiveRedisStreamMessageProducer.setExtractPayload(boolean)

autoAck

public RedisStreamInboundChannelAdapterSpec autoAck(boolean autoAck)

Specify whether acknowledge message read in the Consumer Group.

Parameters:

autoAck - the acknowledge option

Returns:

the spec

See Also:

• ReactiveRedisStreamMessageProducer.setAutoAck(boolean)

consumerGroup

public RedisStreamInboundChannelAdapterSpec consumerGroup(String consumerGroup)

Specify the name of the consumer group.

Parameters:

consumerGroup - the consumerGroup

Returns:

the spec

See Also:

• ReactiveRedisStreamMessageProducer.setConsumerGroup(String)

consumerName

public RedisStreamInboundChannelAdapterSpec consumerName(@Nullable String consumerName)

Specify the name of the consumer.

Parameters:

consumerName - the consumerName

Returns:

the spec

See Also:

• ReactiveRedisStreamMessageProducer.setConsumerName(String)

createConsumerGroup

public RedisStreamInboundChannelAdapterSpec createConsumerGroup(boolean createConsumerGroup)

Specify whether create the consumer group.

Parameters:

createConsumerGroup - the createConsumerGroup

Returns:

the spec

See Also:

• ReactiveRedisStreamMessageProducer.setCreateConsumerGroup(boolean)

streamReceiverOptions

public RedisStreamInboundChannelAdapterSpec streamReceiverOptions(@Nullable StreamReceiver.StreamReceiverOptions<String,?> streamReceiverOptions)

Specify the streamReceiverOptions to customize the StreamReceiver.

Parameters:

streamReceiverOptions - the streamReceiverOptions

Returns:

the spec

See Also:

• ReactiveRedisStreamMessageProducer.setStreamReceiverOptions(StreamReceiver.StreamReceiverOptions)

pollTimeout

public RedisStreamInboundChannelAdapterSpec pollTimeout(Duration pollTimeout)

Specify the poll timeout for the BLOCK option.

Parameters:

pollTimeout - the pollTimeout

Returns:

the spec

See Also:

• ReactiveRedisStreamMessageProducer.setPollTimeout(Duration)

batchSize

public RedisStreamInboundChannelAdapterSpec batchSize(int recordsPerPoll)

Specify the batch size for the COUNT option.

Parameters:

recordsPerPoll - the recordsPerPoll

Returns:

the spec

See Also:

• ReactiveRedisStreamMessageProducer.setBatchSize(int)

errorResumeFunction

public RedisStreamInboundChannelAdapterSpec errorResumeFunction(Function<? super Throwable,? extends org.reactivestreams.Publisher<Void>> resumeFunction)

Specify the resume Function when polling the stream fails.

Parameters:

resumeFunction - the resumeFunction

Returns:

the spec

See Also:

• ReactiveRedisStreamMessageProducer.setOnErrorResume(Function)

serializer

public RedisStreamInboundChannelAdapterSpec serializer(RedisSerializationContext.SerializationPair<?> pair)

Specify the key, hash key and hash value serializer.

Parameters:

pair - the pair

Returns:

the spec

See Also:

• ReactiveRedisStreamMessageProducer.setSerializer(RedisSerializationContext.SerializationPair)

targetType

public RedisStreamInboundChannelAdapterSpec targetType(Class<?> targetType)

Specify the hash target type.

Parameters:

targetType - the targetType

Returns:

the spec

See Also:

• ReactiveRedisStreamMessageProducer.setTargetType(Class)

objectMapper

public RedisStreamInboundChannelAdapterSpec objectMapper(HashMapper<?,?,?> hashMapper)

Specify the hashMapper.

Parameters:

hashMapper - the hashMapper

Returns:

the spec

See Also:

• ReactiveRedisStreamMessageProducer.setObjectMapper(HashMapper)