Class: TencentCloud::Trocket::V20230308::DescribeMessageListRequest

Inherits:

Common::AbstractModel

• Object
• Common::AbstractModel
• TencentCloud::Trocket::V20230308::DescribeMessageListRequest

Defined in:

lib/v20230308/models.rb

Overview

DescribeMessageList请求参数结构体

Instance Attribute Summary

• #ConsumerGroup ⇒ Object
• #EndTime ⇒ Object
• #InstanceId ⇒ Object
• #Limit ⇒ Object
• #MsgId ⇒ Object
• #MsgKey ⇒ Object
• #Offset ⇒ Object
• #QueryDeadLetterMessage ⇒ Object
• #RecentMessageNum ⇒ Object
• #StartTime ⇒ Object
• #Tag ⇒ Object
• #TaskRequestId ⇒ Object
• #Topic ⇒ Object

Instance Method Summary

• #deserialize(params) ⇒ Object
• #initialize(instanceid = nil, topic = nil, starttime = nil, endtime = nil, taskrequestid = nil, offset = nil, limit = nil, consumergroup = nil, msgid = nil, msgkey = nil, recentmessagenum = nil, querydeadlettermessage = nil, tag = nil) ⇒ DescribeMessageListRequest constructor

  A new instance of DescribeMessageListRequest.

Constructor Details

#initialize(instanceid = nil, topic = nil, starttime = nil, endtime = nil, taskrequestid = nil, offset = nil, limit = nil, consumergroup = nil, msgid = nil, msgkey = nil, recentmessagenum = nil, querydeadlettermessage = nil, tag = nil) ⇒ DescribeMessageListRequest

Returns a new instance of DescribeMessageListRequest.

# File 'lib/v20230308/models.rb', line 2698

def initialize(instanceid=nil, topic=nil, starttime=nil, endtime=nil, taskrequestid=nil, offset=nil, limit=nil, consumergroup=nil, msgid=nil, msgkey=nil, recentmessagenum=nil, querydeadlettermessage=nil, tag=nil)
  @InstanceId = instanceid
  @Topic = topic
  @StartTime = starttime
  @EndTime = endtime
  @TaskRequestId = taskrequestid
  @Offset = offset
  @Limit = limit
  @ConsumerGroup = consumergroup
  @MsgId = msgid
  @MsgKey = msgkey
  @RecentMessageNum = recentmessagenum
  @QueryDeadLetterMessage = querydeadlettermessage
  @Tag = tag
end

Instance Attribute Details

#ConsumerGroup ⇒ Object

Parameters:

• InstanceId: —

  腾讯云 RocketMQ 实例 ID，从 DescribeFusionInstanceList 接口或控制台获得。

• Topic: —

  主题名称，从 DescribeTopicList 接口返回的 TopicItem 或控制台获得。

• StartTime: —

  要查询消息的开始时间，Unix时间戳（毫秒）

• EndTime: —

  要查询消息的结束时间，Unix时间戳（毫秒）

• TaskRequestId: —

  一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。

• Offset: —

  查询起始位置，默认为0。

• Limit: —

  查询结果限制数量，默认20。

• ConsumerGroup: —

  消费组名称，从 DescribeConsumerGroupList 接口返回的 ConsumeGroupItem 或控制台获得。

• MsgId: —

  消息 ID，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• MsgKey: —

  消息 Key，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• RecentMessageNum: —

  查询最近N条消息 最大不超过1024，默认-1为其他查询条件

• QueryDeadLetterMessage: —

  是否查询死信消息，默认为false

• Tag: —

  消息 Tag，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

# File 'lib/v20230308/models.rb', line 2696

def ConsumerGroup
  @ConsumerGroup
end

#EndTime ⇒ Object

Parameters:

• InstanceId: —

  腾讯云 RocketMQ 实例 ID，从 DescribeFusionInstanceList 接口或控制台获得。

• Topic: —

  主题名称，从 DescribeTopicList 接口返回的 TopicItem 或控制台获得。

• StartTime: —

  要查询消息的开始时间，Unix时间戳（毫秒）

• EndTime: —

  要查询消息的结束时间，Unix时间戳（毫秒）

• TaskRequestId: —

  一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。

• Offset: —

  查询起始位置，默认为0。

• Limit: —

  查询结果限制数量，默认20。

• ConsumerGroup: —

  消费组名称，从 DescribeConsumerGroupList 接口返回的 ConsumeGroupItem 或控制台获得。

• MsgId: —

  消息 ID，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• MsgKey: —

  消息 Key，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• RecentMessageNum: —

  查询最近N条消息 最大不超过1024，默认-1为其他查询条件

• QueryDeadLetterMessage: —

  是否查询死信消息，默认为false

• Tag: —

  消息 Tag，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

# File 'lib/v20230308/models.rb', line 2696

def EndTime
  @EndTime
end

#InstanceId ⇒ Object

Parameters:

• InstanceId: —

  腾讯云 RocketMQ 实例 ID，从 DescribeFusionInstanceList 接口或控制台获得。

• Topic: —

  主题名称，从 DescribeTopicList 接口返回的 TopicItem 或控制台获得。

• StartTime: —

  要查询消息的开始时间，Unix时间戳（毫秒）

• EndTime: —

  要查询消息的结束时间，Unix时间戳（毫秒）

• TaskRequestId: —

  一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。

• Offset: —

  查询起始位置，默认为0。

• Limit: —

  查询结果限制数量，默认20。

• ConsumerGroup: —

  消费组名称，从 DescribeConsumerGroupList 接口返回的 ConsumeGroupItem 或控制台获得。

• MsgId: —

  消息 ID，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• MsgKey: —

  消息 Key，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• RecentMessageNum: —

  查询最近N条消息 最大不超过1024，默认-1为其他查询条件

• QueryDeadLetterMessage: —

  是否查询死信消息，默认为false

• Tag: —

  消息 Tag，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

# File 'lib/v20230308/models.rb', line 2696

def InstanceId
  @InstanceId
end

#Limit ⇒ Object

Parameters:

• InstanceId: —

  腾讯云 RocketMQ 实例 ID，从 DescribeFusionInstanceList 接口或控制台获得。

• Topic: —

  主题名称，从 DescribeTopicList 接口返回的 TopicItem 或控制台获得。

• StartTime: —

  要查询消息的开始时间，Unix时间戳（毫秒）

• EndTime: —

  要查询消息的结束时间，Unix时间戳（毫秒）

• TaskRequestId: —

  一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。

• Offset: —

  查询起始位置，默认为0。

• Limit: —

  查询结果限制数量，默认20。

• ConsumerGroup: —

  消费组名称，从 DescribeConsumerGroupList 接口返回的 ConsumeGroupItem 或控制台获得。

• MsgId: —

  消息 ID，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• MsgKey: —

  消息 Key，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• RecentMessageNum: —

  查询最近N条消息 最大不超过1024，默认-1为其他查询条件

• QueryDeadLetterMessage: —

  是否查询死信消息，默认为false

• Tag: —

  消息 Tag，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

# File 'lib/v20230308/models.rb', line 2696

def Limit
  @Limit
end

#MsgId ⇒ Object

Parameters:

• InstanceId: —

  腾讯云 RocketMQ 实例 ID，从 DescribeFusionInstanceList 接口或控制台获得。

• Topic: —

  主题名称，从 DescribeTopicList 接口返回的 TopicItem 或控制台获得。

• StartTime: —

  要查询消息的开始时间，Unix时间戳（毫秒）

• EndTime: —

  要查询消息的结束时间，Unix时间戳（毫秒）

• TaskRequestId: —

  一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。

• Offset: —

  查询起始位置，默认为0。

• Limit: —

  查询结果限制数量，默认20。

• ConsumerGroup: —

  消费组名称，从 DescribeConsumerGroupList 接口返回的 ConsumeGroupItem 或控制台获得。

• MsgId: —

  消息 ID，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• MsgKey: —

  消息 Key，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• RecentMessageNum: —

  查询最近N条消息 最大不超过1024，默认-1为其他查询条件

• QueryDeadLetterMessage: —

  是否查询死信消息，默认为false

• Tag: —

  消息 Tag，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

# File 'lib/v20230308/models.rb', line 2696

def MsgId
  @MsgId
end

#MsgKey ⇒ Object

Parameters:

• InstanceId: —

  腾讯云 RocketMQ 实例 ID，从 DescribeFusionInstanceList 接口或控制台获得。

• Topic: —

  主题名称，从 DescribeTopicList 接口返回的 TopicItem 或控制台获得。

• StartTime: —

  要查询消息的开始时间，Unix时间戳（毫秒）

• EndTime: —

  要查询消息的结束时间，Unix时间戳（毫秒）

• TaskRequestId: —

  一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。

• Offset: —

  查询起始位置，默认为0。

• Limit: —

  查询结果限制数量，默认20。

• ConsumerGroup: —

  消费组名称，从 DescribeConsumerGroupList 接口返回的 ConsumeGroupItem 或控制台获得。

• MsgId: —

  消息 ID，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• MsgKey: —

  消息 Key，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• RecentMessageNum: —

  查询最近N条消息 最大不超过1024，默认-1为其他查询条件

• QueryDeadLetterMessage: —

  是否查询死信消息，默认为false

• Tag: —

  消息 Tag，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

# File 'lib/v20230308/models.rb', line 2696

def MsgKey
  @MsgKey
end

#Offset ⇒ Object

Parameters:

• InstanceId: —

  腾讯云 RocketMQ 实例 ID，从 DescribeFusionInstanceList 接口或控制台获得。

• Topic: —

  主题名称，从 DescribeTopicList 接口返回的 TopicItem 或控制台获得。

• StartTime: —

  要查询消息的开始时间，Unix时间戳（毫秒）

• EndTime: —

  要查询消息的结束时间，Unix时间戳（毫秒）

• TaskRequestId: —

  一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。

• Offset: —

  查询起始位置，默认为0。

• Limit: —

  查询结果限制数量，默认20。

• ConsumerGroup: —

  消费组名称，从 DescribeConsumerGroupList 接口返回的 ConsumeGroupItem 或控制台获得。

• MsgId: —

  消息 ID，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• MsgKey: —

  消息 Key，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• RecentMessageNum: —

  查询最近N条消息 最大不超过1024，默认-1为其他查询条件

• QueryDeadLetterMessage: —

  是否查询死信消息，默认为false

• Tag: —

  消息 Tag，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

# File 'lib/v20230308/models.rb', line 2696

def Offset
  @Offset
end

#QueryDeadLetterMessage ⇒ Object

Parameters:

• InstanceId: —

  腾讯云 RocketMQ 实例 ID，从 DescribeFusionInstanceList 接口或控制台获得。

• Topic: —

  主题名称，从 DescribeTopicList 接口返回的 TopicItem 或控制台获得。

• StartTime: —

  要查询消息的开始时间，Unix时间戳（毫秒）

• EndTime: —

  要查询消息的结束时间，Unix时间戳（毫秒）

• TaskRequestId: —

  一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。

• Offset: —

  查询起始位置，默认为0。

• Limit: —

  查询结果限制数量，默认20。

• ConsumerGroup: —

  消费组名称，从 DescribeConsumerGroupList 接口返回的 ConsumeGroupItem 或控制台获得。

• MsgId: —

  消息 ID，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• MsgKey: —

  消息 Key，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• RecentMessageNum: —

  查询最近N条消息 最大不超过1024，默认-1为其他查询条件

• QueryDeadLetterMessage: —

  是否查询死信消息，默认为false

• Tag: —

  消息 Tag，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

# File 'lib/v20230308/models.rb', line 2696

def QueryDeadLetterMessage
  @QueryDeadLetterMessage
end

#RecentMessageNum ⇒ Object

Parameters:

• InstanceId: —

  腾讯云 RocketMQ 实例 ID，从 DescribeFusionInstanceList 接口或控制台获得。

• Topic: —

  主题名称，从 DescribeTopicList 接口返回的 TopicItem 或控制台获得。

• StartTime: —

  要查询消息的开始时间，Unix时间戳（毫秒）

• EndTime: —

  要查询消息的结束时间，Unix时间戳（毫秒）

• TaskRequestId: —

  一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。

• Offset: —

  查询起始位置，默认为0。

• Limit: —

  查询结果限制数量，默认20。

• ConsumerGroup: —

  消费组名称，从 DescribeConsumerGroupList 接口返回的 ConsumeGroupItem 或控制台获得。

• MsgId: —

  消息 ID，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• MsgKey: —

  消息 Key，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• RecentMessageNum: —

  查询最近N条消息 最大不超过1024，默认-1为其他查询条件

• QueryDeadLetterMessage: —

  是否查询死信消息，默认为false

• Tag: —

  消息 Tag，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

# File 'lib/v20230308/models.rb', line 2696

def RecentMessageNum
  @RecentMessageNum
end

#StartTime ⇒ Object

Parameters:

• InstanceId: —

  腾讯云 RocketMQ 实例 ID，从 DescribeFusionInstanceList 接口或控制台获得。

• Topic: —

  主题名称，从 DescribeTopicList 接口返回的 TopicItem 或控制台获得。

• StartTime: —

  要查询消息的开始时间，Unix时间戳（毫秒）

• EndTime: —

  要查询消息的结束时间，Unix时间戳（毫秒）

• TaskRequestId: —

  一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。

• Offset: —

  查询起始位置，默认为0。

• Limit: —

  查询结果限制数量，默认20。

• ConsumerGroup: —

  消费组名称，从 DescribeConsumerGroupList 接口返回的 ConsumeGroupItem 或控制台获得。

• MsgId: —

  消息 ID，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• MsgKey: —

  消息 Key，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• RecentMessageNum: —

  查询最近N条消息 最大不超过1024，默认-1为其他查询条件

• QueryDeadLetterMessage: —

  是否查询死信消息，默认为false

• Tag: —

  消息 Tag，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

# File 'lib/v20230308/models.rb', line 2696

def StartTime
  @StartTime
end

#Tag ⇒ Object

Parameters:

• InstanceId: —

  腾讯云 RocketMQ 实例 ID，从 DescribeFusionInstanceList 接口或控制台获得。

• Topic: —

  主题名称，从 DescribeTopicList 接口返回的 TopicItem 或控制台获得。

• StartTime: —

  要查询消息的开始时间，Unix时间戳（毫秒）

• EndTime: —

  要查询消息的结束时间，Unix时间戳（毫秒）

• TaskRequestId: —

  一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。

• Offset: —

  查询起始位置，默认为0。

• Limit: —

  查询结果限制数量，默认20。

• ConsumerGroup: —

  消费组名称，从 DescribeConsumerGroupList 接口返回的 ConsumeGroupItem 或控制台获得。

• MsgId: —

  消息 ID，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• MsgKey: —

  消息 Key，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• RecentMessageNum: —

  查询最近N条消息 最大不超过1024，默认-1为其他查询条件

• QueryDeadLetterMessage: —

  是否查询死信消息，默认为false

• Tag: —

  消息 Tag，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

# File 'lib/v20230308/models.rb', line 2696

def Tag
  @Tag
end

#TaskRequestId ⇒ Object

Parameters:

• InstanceId: —

  腾讯云 RocketMQ 实例 ID，从 DescribeFusionInstanceList 接口或控制台获得。

• Topic: —

  主题名称，从 DescribeTopicList 接口返回的 TopicItem 或控制台获得。

• StartTime: —

  要查询消息的开始时间，Unix时间戳（毫秒）

• EndTime: —

  要查询消息的结束时间，Unix时间戳（毫秒）

• TaskRequestId: —

  一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。

• Offset: —

  查询起始位置，默认为0。

• Limit: —

  查询结果限制数量，默认20。

• ConsumerGroup: —

  消费组名称，从 DescribeConsumerGroupList 接口返回的 ConsumeGroupItem 或控制台获得。

• MsgId: —

  消息 ID，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• MsgKey: —

  消息 Key，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• RecentMessageNum: —

  查询最近N条消息 最大不超过1024，默认-1为其他查询条件

• QueryDeadLetterMessage: —

  是否查询死信消息，默认为false

• Tag: —

  消息 Tag，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

# File 'lib/v20230308/models.rb', line 2696

def TaskRequestId
  @TaskRequestId
end

#Topic ⇒ Object

Parameters:

• InstanceId: —

  腾讯云 RocketMQ 实例 ID，从 DescribeFusionInstanceList 接口或控制台获得。

• Topic: —

  主题名称，从 DescribeTopicList 接口返回的 TopicItem 或控制台获得。

• StartTime: —

  要查询消息的开始时间，Unix时间戳（毫秒）

• EndTime: —

  要查询消息的结束时间，Unix时间戳（毫秒）

• TaskRequestId: —

  一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。

• Offset: —

  查询起始位置，默认为0。

• Limit: —

  查询结果限制数量，默认20。

• ConsumerGroup: —

  消费组名称，从 DescribeConsumerGroupList 接口返回的 ConsumeGroupItem 或控制台获得。

• MsgId: —

  消息 ID，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• MsgKey: —

  消息 Key，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

• RecentMessageNum: —

  查询最近N条消息 最大不超过1024，默认-1为其他查询条件

• QueryDeadLetterMessage: —

  是否查询死信消息，默认为false

• Tag: —

  消息 Tag，从 DescribeMessageList 接口返回的 MessageItem 或业务日志中获得。

# File 'lib/v20230308/models.rb', line 2696

def Topic
  @Topic
end

Instance Method Details

#deserialize(params) ⇒ Object

# File 'lib/v20230308/models.rb', line 2714

def deserialize(params)
  @InstanceId = params['InstanceId']
  @Topic = params['Topic']
  @StartTime = params['StartTime']
  @EndTime = params['EndTime']
  @TaskRequestId = params['TaskRequestId']
  @Offset = params['Offset']
  @Limit = params['Limit']
  @ConsumerGroup = params['ConsumerGroup']
  @MsgId = params['MsgId']
  @MsgKey = params['MsgKey']
  @RecentMessageNum = params['RecentMessageNum']
  @QueryDeadLetterMessage = params['QueryDeadLetterMessage']
  @Tag = params['Tag']
end