Serialized Form (Spring Cloud Starter Stream RocketMQ 2021.0.1.0 API)

Package com.alibaba.cloud.stream.binder.rocketmq.properties
- Class com.alibaba.cloud.stream.binder.rocketmq.properties.RocketMQBinderConfigurationProperties extends RocketMQCommonProperties implements Serializable
- Class com.alibaba.cloud.stream.binder.rocketmq.properties.RocketMQCommonProperties extends Object implements Serializable
  
  serialVersionUID:
  
  -6724870154343284715L
  - Serialized Fields
    - enabled
```
boolean enabled
```
    - nameServer
```
String nameServer
```
    - accessKey
```
String accessKey
```
      The property of "access-key".
    - secretKey
```
String secretKey
```
      The property of "secret-key".
    - group
```
String group
```
      Consumers of the same role is required to have exactly same subscriptions and consumerGroup to correctly achieve load balance. It's required and needs to be globally unique. Producer group conceptually aggregates all producer instances of exactly same role, which is particularly important when transactional messages are involved. For non-transactional messages, it does not matter as long as it's unique per process. See here for further discussion.
    - namespace
```
String namespace
```
    - unitName
```
String unitName
```
      The property of "unitName".
    - accessChannel
```
String accessChannel
```
    - pollNameServerInterval
```
int pollNameServerInterval
```
      Pulling topic information interval from the named server. seeMQClientInstance.startScheduledTask(),eg:ScheduledTask updateTopicRouteInfoFromNameServer.
    - heartbeatBrokerInterval
```
int heartbeatBrokerInterval
```
      Heartbeat interval in microseconds with message broker. seeMQClientInstance.startScheduledTask(),eg:ScheduledTask sendHeartbeatToAllBroker .
    - persistConsumerOffsetInterval
```
int persistConsumerOffsetInterval
```
      Offset persistent interval for consumer. seeMQClientInstance.startScheduledTask(),eg:ScheduledTask sendHeartbeatToAllBroker .
    - vipChannelEnabled
```
boolean vipChannelEnabled
```
    - useTLS
```
boolean useTLS
```
    - enableMsgTrace
```
boolean enableMsgTrace
```
    - customizedTraceTopic
```
String customizedTraceTopic
```
- Class com.alibaba.cloud.stream.binder.rocketmq.properties.RocketMQConsumerProperties extends RocketMQCommonProperties implements Serializable
  - Serialized Fields
    - messageModel
```
String messageModel
```
      Message model defines the way how messages are delivered to each consumer clients. This field defaults to clustering.
    - allocateMessageQueueStrategy
```
String allocateMessageQueueStrategy
```
      Queue allocation algorithm specifying how message queues are allocated to each consumer clients.
    - subscription
```
String subscription
```
      The expressions include tags or SQL,as follow:
      tag: tag1||tag2||tag3 ; sql: 'color'='blue' AND 'price'>100 .
      Determines whether there are specific characters "||" in the expression to determine how the message is filtered,tags or SQL.
    - pullTimeDelayMillsWhenException
```
long pullTimeDelayMillsWhenException
```
      Delay some time when exception occur .
    - consumeFromWhere
```
org.apache.rocketmq.common.consumer.ConsumeFromWhere consumeFromWhere
```
      Consuming point on consumer booting. There are three consuming points:
      
      CONSUME_FROM_LAST_OFFSET: consumer clients pick up where it stopped previously. If it were a newly booting up consumer client, according aging of the consumer group, there are two cases:
      
      if the consumer group is created so recently that the earliest message being subscribed has yet expired, which means the consumer group represents a lately launched business, consuming will start from the very beginning;
      
      if the earliest message being subscribed has expired, consuming will start from the latest messages, meaning messages born prior to the booting timestamp would be ignored.
      
      CONSUME_FROM_FIRST_OFFSET: Consumer client will start from earliest messages available.
      
      CONSUME_FROM_TIMESTAMP: Consumer client will start from specified timestamp, which means messages born prior to RocketMQConsumerProperties.consumeTimestamp will be ignored
    - consumeTimestamp
```
String consumeTimestamp
```
      Backtracking consumption time with second precision. Time format is 20131223171201
      Implying Seventeen twelve and 01 seconds on December 23, 2013 year
      Default backtracking consumption time Half an hour ago.
    - pullThresholdForQueue
```
int pullThresholdForQueue
```
      Flow control threshold on queue level, each message queue will cache at most 1000 messages by default, Consider the RocketMQConsumerProperties.pullBatchSize, the instantaneous value may exceed the limit .
    - pullThresholdSizeForQueue
```
int pullThresholdSizeForQueue
```
      Limit the cached message size on queue level, each message queue will cache at most 100 MiB messages by default, Consider the RocketMQConsumerProperties.pullBatchSize, the instantaneous value may exceed the limit .
      The size of a message only measured by message body, so it's not accurate
    - pullBatchSize
```
int pullBatchSize
```
      Maximum number of messages pulled each time.
    - consumeMaxSpan
```
int consumeMaxSpan
```
      Consume max span offset.it has no effect on sequential consumption.
    - push
```
RocketMQConsumerProperties.Push push
```
    - pull
```
RocketMQConsumerProperties.Pull pull
```
- Class com.alibaba.cloud.stream.binder.rocketmq.properties.RocketMQConsumerProperties.Pull extends Object implements Serializable
  - Serialized Fields
    - pollTimeoutMillis
```
long pollTimeoutMillis
```
      The poll timeout in milliseconds.
    - pullThreadNums
```
int pullThreadNums
```
      Pull thread number.
    - topicMetadataCheckIntervalMillis
```
long topicMetadataCheckIntervalMillis
```
      Interval time in in milliseconds for checking changes in topic metadata.
    - consumerTimeoutMillisWhenSuspend
```
long consumerTimeoutMillisWhenSuspend
```
      Long polling mode, the Consumer connection timeout(must greater than brokerSuspendMaxTimeMillis), it is not recommended to modify.
    - errAcknowledge
```
String errAcknowledge
```
      Ack state handling, including receive, reject, and retry, when a consumption exception occurs.
    - pullThresholdForAll
```
long pullThresholdForAll
```
- Class com.alibaba.cloud.stream.binder.rocketmq.properties.RocketMQConsumerProperties.Push extends Object implements Serializable
  
  serialVersionUID:
  
  -7398468554978817630L
  - Serialized Fields
    - orderly
```
boolean orderly
```
      if orderly is true, using MessageListenerOrderly else if orderly if false, using MessageListenerConcurrently.
    - suspendCurrentQueueTimeMillis
```
int suspendCurrentQueueTimeMillis
```
      Suspending pulling time for cases requiring slow pulling like flow-control scenario. seeConsumeMessageOrderlyService.processConsumeResult(java.util.List<org.apache.rocketmq.common.message.MessageExt>, org.apache.rocketmq.client.consumer.listener.ConsumeOrderlyStatus, org.apache.rocketmq.client.consumer.listener.ConsumeOrderlyContext, org.apache.rocketmq.client.impl.consumer.ConsumeMessageOrderlyService.ConsumeRequest). seeConsumeOrderlyContext.getSuspendCurrentQueueTimeMillis().
    - maxReconsumeTimes
```
int maxReconsumeTimes
```
      https://github.com/alibaba/spring-cloud-alibaba/issues/1866 Max re-consume times. -1 means 16 times. If messages are re-consumed more than RocketMQConsumerProperties.Push.maxReconsumeTimes before success, it's be directed to a deletion queue waiting.
    - delayLevelWhenNextConsume
```
int delayLevelWhenNextConsume
```
      for concurrently listener. message consume retry strategy. -1 means dlq(or discard. see ConsumeMessageConcurrentlyService.processConsumeResult(org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyStatus, org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyContext, org.apache.rocketmq.client.impl.consumer.ConsumeMessageConcurrentlyService.ConsumeRequest). see ConsumeConcurrentlyContext.getDelayLevelWhenNextConsume().
    - pullThresholdForTopic
```
int pullThresholdForTopic
```
      Flow control threshold on topic level, default value is -1(Unlimited)
      The value of pullThresholdForQueue will be overwrote and calculated based on pullThresholdForTopic if it is't unlimited
      For example, if the value of pullThresholdForTopic is 1000 and 10 message queues are assigned to this consumer, then pullThresholdForQueue will be set to 100.
    - pullThresholdSizeForTopic
```
int pullThresholdSizeForTopic
```
      Limit the cached message size on topic level, default value is -1 MiB(Unlimited)
      The value of pullThresholdSizeForQueue will be overwrote and calculated based on pullThresholdSizeForTopic if it is't unlimited .
      For example, if the value of pullThresholdSizeForTopic is 1000 MiB and 10 message queues are assigned to this consumer, then pullThresholdSizeForQueue will be set to 100 MiB .
    - pullInterval
```
long pullInterval
```
      Message pull Interval.
    - consumeMessageBatchMaxSize
```
int consumeMessageBatchMaxSize
```
      Batch consumption size.
- Class com.alibaba.cloud.stream.binder.rocketmq.properties.RocketMQProducerProperties extends RocketMQCommonProperties implements Serializable
  - Serialized Fields
    - sendMsgTimeout
```
int sendMsgTimeout
```
      Timeout for sending messages.
    - compressMsgBodyThreshold
```
int compressMsgBodyThreshold
```
      Compress message body threshold, namely, message body larger than 4k will be compressed on default.
    - retryTimesWhenSendFailed
```
int retryTimesWhenSendFailed
```
      Maximum number of retry to perform internally before claiming sending failure in synchronous mode. This may potentially cause message duplication which is up to application developers to resolve.
    - retryTimesWhenSendAsyncFailed
```
int retryTimesWhenSendAsyncFailed
```
      Maximum number of retry to perform internally before claiming sending failure in asynchronous mode. This may potentially cause message duplication which is up to application developers to resolve.
    - retryAnotherBroker
```
boolean retryAnotherBroker
```
      Indicate whether to retry another broker on sending failure internally.
    - maxMessageSize
```
int maxMessageSize
```
      Maximum allowed message size in bytes.
    - producerType
```
String producerType
```
    - sendType
```
String sendType
```
    - sendCallBack
```
String sendCallBack
```
    - transactionListener
```
String transactionListener
```
    - messageQueueSelector
```
String messageQueueSelector
```
    - errorMessageStrategy
```
String errorMessageStrategy
```
    - sendFailureChannel
```
String sendFailureChannel
```
    - checkForbiddenHook
```
String checkForbiddenHook
```
    - sendMessageHook
```
String sendMessageHook
```

Serialized Form

Package com.alibaba.cloud.stream.binder.rocketmq.properties

Class com.alibaba.cloud.stream.binder.rocketmq.properties.RocketMQBinderConfigurationProperties extends RocketMQCommonProperties implements Serializable

Class com.alibaba.cloud.stream.binder.rocketmq.properties.RocketMQCommonProperties extends Object implements Serializable

Serialized Fields

enabled

nameServer

accessKey

secretKey

group

namespace

unitName

accessChannel

pollNameServerInterval

heartbeatBrokerInterval

persistConsumerOffsetInterval

vipChannelEnabled

useTLS

enableMsgTrace

customizedTraceTopic

Class com.alibaba.cloud.stream.binder.rocketmq.properties.RocketMQConsumerProperties extends RocketMQCommonProperties implements Serializable

Serialized Fields

messageModel

allocateMessageQueueStrategy

subscription

pullTimeDelayMillsWhenException

consumeFromWhere

consumeTimestamp

pullThresholdForQueue

pullThresholdSizeForQueue

pullBatchSize

consumeMaxSpan

push

pull

Class com.alibaba.cloud.stream.binder.rocketmq.properties.RocketMQConsumerProperties.Pull extends Object implements Serializable

Serialized Fields

pollTimeoutMillis

pullThreadNums

topicMetadataCheckIntervalMillis

consumerTimeoutMillisWhenSuspend

errAcknowledge

pullThresholdForAll

Class com.alibaba.cloud.stream.binder.rocketmq.properties.RocketMQConsumerProperties.Push extends Object implements Serializable

Serialized Fields

orderly

suspendCurrentQueueTimeMillis

maxReconsumeTimes

delayLevelWhenNextConsume

pullThresholdForTopic

pullThresholdSizeForTopic

pullInterval

consumeMessageBatchMaxSize

Class com.alibaba.cloud.stream.binder.rocketmq.properties.RocketMQProducerProperties extends RocketMQCommonProperties implements Serializable

Serialized Fields

sendMsgTimeout

compressMsgBodyThreshold

retryTimesWhenSendFailed

retryTimesWhenSendAsyncFailed

retryAnotherBroker

maxMessageSize

producerType

sendType

sendCallBack

transactionListener

messageQueueSelector

errorMessageStrategy

sendFailureChannel

checkForbiddenHook

sendMessageHook