Class: TencentCloud::Tdmq::V20200217::ReceiveMessageRequest

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20200217/models.rb

Overview

ReceiveMessage请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(topic = nil, subscriptionname = nil, receiverqueuesize = nil, subinitialposition = nil, maxnummessages = nil, maxnumbytes = nil, timeout = nil) ⇒ ReceiveMessageRequest

Returns a new instance of ReceiveMessageRequest.



11105
11106
11107
11108
11109
11110
11111
11112
11113
# File 'lib/v20200217/models.rb', line 11105

def initialize(topic=nil, subscriptionname=nil, receiverqueuesize=nil, subinitialposition=nil, maxnummessages=nil, maxnumbytes=nil, timeout=nil)
  @Topic = topic
  @SubscriptionName = subscriptionname
  @ReceiverQueueSize = receiverqueuesize
  @SubInitialPosition = subinitialposition
  @MaxNumMessages = maxnummessages
  @MaxNumBytes = maxnumbytes
  @Timeout = timeout
end

Instance Attribute Details

#MaxNumBytesObject

Parameters:

  • Topic:

    接收消息的topic的名字, 这里尽量需要使用topic的全路径,如果不指定,即:tenant/namespace/topic。默认使用的是:public/default

  • SubscriptionName:

    订阅者的名字

  • ReceiverQueueSize:

    默认值为1000,consumer接收的消息会首先存储到receiverQueueSize这个队列中,用作调优接收消息的速率

  • SubInitialPosition:

    默认值为:Earliest。用作判定consumer初始接收消息的位置,可选参数为:Earliest, Latest

  • MaxNumMessages:

    用于设置BatchReceivePolicy,指在一次batch中最多接收多少条消息,默认是 0。即不开启BatchReceivePolicy

  • MaxNumBytes:

    用于设置BatchReceivePolicy,指在一次batch中最多接收的消息体有多大,单位是 bytes。默认是 0,即不开启BatchReceivePolicy

  • Timeout:

    用于设置BatchReceivePolicy,指在一次batch消息的接收z中最多等待的超时时间,单位是毫秒。默认是 0,即不开启BatchReceivePolicy



11103
11104
11105
# File 'lib/v20200217/models.rb', line 11103

def MaxNumBytes
  @MaxNumBytes
end

#MaxNumMessagesObject

Parameters:

  • Topic:

    接收消息的topic的名字, 这里尽量需要使用topic的全路径,如果不指定,即:tenant/namespace/topic。默认使用的是:public/default

  • SubscriptionName:

    订阅者的名字

  • ReceiverQueueSize:

    默认值为1000,consumer接收的消息会首先存储到receiverQueueSize这个队列中,用作调优接收消息的速率

  • SubInitialPosition:

    默认值为:Earliest。用作判定consumer初始接收消息的位置,可选参数为:Earliest, Latest

  • MaxNumMessages:

    用于设置BatchReceivePolicy,指在一次batch中最多接收多少条消息,默认是 0。即不开启BatchReceivePolicy

  • MaxNumBytes:

    用于设置BatchReceivePolicy,指在一次batch中最多接收的消息体有多大,单位是 bytes。默认是 0,即不开启BatchReceivePolicy

  • Timeout:

    用于设置BatchReceivePolicy,指在一次batch消息的接收z中最多等待的超时时间,单位是毫秒。默认是 0,即不开启BatchReceivePolicy



11103
11104
11105
# File 'lib/v20200217/models.rb', line 11103

def MaxNumMessages
  @MaxNumMessages
end

#ReceiverQueueSizeObject

Parameters:

  • Topic:

    接收消息的topic的名字, 这里尽量需要使用topic的全路径,如果不指定,即:tenant/namespace/topic。默认使用的是:public/default

  • SubscriptionName:

    订阅者的名字

  • ReceiverQueueSize:

    默认值为1000,consumer接收的消息会首先存储到receiverQueueSize这个队列中,用作调优接收消息的速率

  • SubInitialPosition:

    默认值为:Earliest。用作判定consumer初始接收消息的位置,可选参数为:Earliest, Latest

  • MaxNumMessages:

    用于设置BatchReceivePolicy,指在一次batch中最多接收多少条消息,默认是 0。即不开启BatchReceivePolicy

  • MaxNumBytes:

    用于设置BatchReceivePolicy,指在一次batch中最多接收的消息体有多大,单位是 bytes。默认是 0,即不开启BatchReceivePolicy

  • Timeout:

    用于设置BatchReceivePolicy,指在一次batch消息的接收z中最多等待的超时时间,单位是毫秒。默认是 0,即不开启BatchReceivePolicy



11103
11104
11105
# File 'lib/v20200217/models.rb', line 11103

def ReceiverQueueSize
  @ReceiverQueueSize
end

#SubInitialPositionObject

Parameters:

  • Topic:

    接收消息的topic的名字, 这里尽量需要使用topic的全路径,如果不指定,即:tenant/namespace/topic。默认使用的是:public/default

  • SubscriptionName:

    订阅者的名字

  • ReceiverQueueSize:

    默认值为1000,consumer接收的消息会首先存储到receiverQueueSize这个队列中,用作调优接收消息的速率

  • SubInitialPosition:

    默认值为:Earliest。用作判定consumer初始接收消息的位置,可选参数为:Earliest, Latest

  • MaxNumMessages:

    用于设置BatchReceivePolicy,指在一次batch中最多接收多少条消息,默认是 0。即不开启BatchReceivePolicy

  • MaxNumBytes:

    用于设置BatchReceivePolicy,指在一次batch中最多接收的消息体有多大,单位是 bytes。默认是 0,即不开启BatchReceivePolicy

  • Timeout:

    用于设置BatchReceivePolicy,指在一次batch消息的接收z中最多等待的超时时间,单位是毫秒。默认是 0,即不开启BatchReceivePolicy



11103
11104
11105
# File 'lib/v20200217/models.rb', line 11103

def SubInitialPosition
  @SubInitialPosition
end

#SubscriptionNameObject

Parameters:

  • Topic:

    接收消息的topic的名字, 这里尽量需要使用topic的全路径,如果不指定,即:tenant/namespace/topic。默认使用的是:public/default

  • SubscriptionName:

    订阅者的名字

  • ReceiverQueueSize:

    默认值为1000,consumer接收的消息会首先存储到receiverQueueSize这个队列中,用作调优接收消息的速率

  • SubInitialPosition:

    默认值为:Earliest。用作判定consumer初始接收消息的位置,可选参数为:Earliest, Latest

  • MaxNumMessages:

    用于设置BatchReceivePolicy,指在一次batch中最多接收多少条消息,默认是 0。即不开启BatchReceivePolicy

  • MaxNumBytes:

    用于设置BatchReceivePolicy,指在一次batch中最多接收的消息体有多大,单位是 bytes。默认是 0,即不开启BatchReceivePolicy

  • Timeout:

    用于设置BatchReceivePolicy,指在一次batch消息的接收z中最多等待的超时时间,单位是毫秒。默认是 0,即不开启BatchReceivePolicy



11103
11104
11105
# File 'lib/v20200217/models.rb', line 11103

def SubscriptionName
  @SubscriptionName
end

#TimeoutObject

Parameters:

  • Topic:

    接收消息的topic的名字, 这里尽量需要使用topic的全路径,如果不指定,即:tenant/namespace/topic。默认使用的是:public/default

  • SubscriptionName:

    订阅者的名字

  • ReceiverQueueSize:

    默认值为1000,consumer接收的消息会首先存储到receiverQueueSize这个队列中,用作调优接收消息的速率

  • SubInitialPosition:

    默认值为:Earliest。用作判定consumer初始接收消息的位置,可选参数为:Earliest, Latest

  • MaxNumMessages:

    用于设置BatchReceivePolicy,指在一次batch中最多接收多少条消息,默认是 0。即不开启BatchReceivePolicy

  • MaxNumBytes:

    用于设置BatchReceivePolicy,指在一次batch中最多接收的消息体有多大,单位是 bytes。默认是 0,即不开启BatchReceivePolicy

  • Timeout:

    用于设置BatchReceivePolicy,指在一次batch消息的接收z中最多等待的超时时间,单位是毫秒。默认是 0,即不开启BatchReceivePolicy



11103
11104
11105
# File 'lib/v20200217/models.rb', line 11103

def Timeout
  @Timeout
end

#TopicObject

Parameters:

  • Topic:

    接收消息的topic的名字, 这里尽量需要使用topic的全路径,如果不指定,即:tenant/namespace/topic。默认使用的是:public/default

  • SubscriptionName:

    订阅者的名字

  • ReceiverQueueSize:

    默认值为1000,consumer接收的消息会首先存储到receiverQueueSize这个队列中,用作调优接收消息的速率

  • SubInitialPosition:

    默认值为:Earliest。用作判定consumer初始接收消息的位置,可选参数为:Earliest, Latest

  • MaxNumMessages:

    用于设置BatchReceivePolicy,指在一次batch中最多接收多少条消息,默认是 0。即不开启BatchReceivePolicy

  • MaxNumBytes:

    用于设置BatchReceivePolicy,指在一次batch中最多接收的消息体有多大,单位是 bytes。默认是 0,即不开启BatchReceivePolicy

  • Timeout:

    用于设置BatchReceivePolicy,指在一次batch消息的接收z中最多等待的超时时间,单位是毫秒。默认是 0,即不开启BatchReceivePolicy



11103
11104
11105
# File 'lib/v20200217/models.rb', line 11103

def Topic
  @Topic
end

Instance Method Details

#deserialize(params) ⇒ Object



11115
11116
11117
11118
11119
11120
11121
11122
11123
# File 'lib/v20200217/models.rb', line 11115

def deserialize(params)
  @Topic = params['Topic']
  @SubscriptionName = params['SubscriptionName']
  @ReceiverQueueSize = params['ReceiverQueueSize']
  @SubInitialPosition = params['SubInitialPosition']
  @MaxNumMessages = params['MaxNumMessages']
  @MaxNumBytes = params['MaxNumBytes']
  @Timeout = params['Timeout']
end