DescribeMessageListRequest (tencentcloud-sdk-java 3.1.1323 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.trocket.v20230308.models.DescribeMessageListRequest

public class DescribeMessageListRequest
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

Constructor Summary

Constructors
Constructor and Description
`DescribeMessageListRequest()`
`DescribeMessageListRequest(DescribeMessageListRequest source)` NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getConsumerGroup()` Get 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
`Long`	`getEndTime()` Get 要查询消息的结束时间，Unix时间戳（毫秒）
`String`	`getInstanceId()` Get 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
`Long`	`getLimit()` Get 查询结果限制数量，默认20。
`String`	`getMsgId()` Get 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
`String`	`getMsgKey()` Get 消息 Key，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
`Long`	`getOffset()` Get 查询起始位置，默认为0。
`Boolean`	`getQueryDeadLetterMessage()` Get 是否查询死信消息，默认为false
`Long`	`getRecentMessageNum()` Get 查询最近N条消息最大不超过1024，默认-1为其他查询条件
`Long`	`getStartTime()` Get 要查询消息的开始时间，Unix时间戳（毫秒）
`String`	`getTag()` Get 消息 Tag，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
`String`	`getTaskRequestId()` Get 一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。
`String`	`getTopic()` Get 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
`void`	`setConsumerGroup(String ConsumerGroup)` Set 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
`void`	`setEndTime(Long EndTime)` Set 要查询消息的结束时间，Unix时间戳（毫秒）
`void`	`setInstanceId(String InstanceId)` Set 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
`void`	`setLimit(Long Limit)` Set 查询结果限制数量，默认20。
`void`	`setMsgId(String MsgId)` Set 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
`void`	`setMsgKey(String MsgKey)` Set 消息 Key，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
`void`	`setOffset(Long Offset)` Set 查询起始位置，默认为0。
`void`	`setQueryDeadLetterMessage(Boolean QueryDeadLetterMessage)` Set 是否查询死信消息，默认为false
`void`	`setRecentMessageNum(Long RecentMessageNum)` Set 查询最近N条消息最大不超过1024，默认-1为其他查询条件
`void`	`setStartTime(Long StartTime)` Set 要查询消息的开始时间，Unix时间戳（毫秒）
`void`	`setTag(String Tag)` Set 消息 Tag，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
`void`	`setTaskRequestId(String TaskRequestId)` Set 一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。
`void`	`setTopic(String Topic)` Set 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
`void`	`toMap(HashMap<String,String> map, String prefix)` Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

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

- Constructor Detail
  - DescribeMessageListRequest
```
public DescribeMessageListRequest()
```
  - DescribeMessageListRequest
```
public DescribeMessageListRequest(DescribeMessageListRequest source)
```
    NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
- Method Detail
  - getInstanceId
```
public String getInstanceId()
```
    Get 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
    
    Returns:
    
    InstanceId 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
  - setInstanceId
```
public void setInstanceId(String InstanceId)
```
    Set 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
    
    Parameters:
    
    InstanceId - 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
  - getTopic
```
public String getTopic()
```
    Get 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
    
    Returns:
    
    Topic 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
  - setTopic
```
public void setTopic(String Topic)
```
    Set 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
    
    Parameters:
    
    Topic - 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
  - getStartTime
```
public Long getStartTime()
```
    Get 要查询消息的开始时间，**Unix时间戳（毫秒）**
    
    Returns:
    
    StartTime 要查询消息的开始时间，**Unix时间戳（毫秒）**
  - setStartTime
```
public void setStartTime(Long StartTime)
```
    Set 要查询消息的开始时间，**Unix时间戳（毫秒）**
    
    Parameters:
    
    StartTime - 要查询消息的开始时间，**Unix时间戳（毫秒）**
  - getEndTime
```
public Long getEndTime()
```
    Get 要查询消息的结束时间，**Unix时间戳（毫秒）**
    
    Returns:
    
    EndTime 要查询消息的结束时间，**Unix时间戳（毫秒）**
  - setEndTime
```
public void setEndTime(Long EndTime)
```
    Set 要查询消息的结束时间，**Unix时间戳（毫秒）**
    
    Parameters:
    
    EndTime - 要查询消息的结束时间，**Unix时间戳（毫秒）**
  - getTaskRequestId
```
public String getTaskRequestId()
```
    Get 一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。
    
    Returns:
    
    TaskRequestId 一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。
  - setTaskRequestId
```
public void setTaskRequestId(String TaskRequestId)
```
    Set 一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。
    
    Parameters:
    
    TaskRequestId - 一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。
  - getOffset
```
public Long getOffset()
```
    Get 查询起始位置，默认为0。
    
    Returns:
    
    Offset 查询起始位置，默认为0。
  - setOffset
```
public void setOffset(Long Offset)
```
    Set 查询起始位置，默认为0。
    
    Parameters:
    
    Offset - 查询起始位置，默认为0。
  - getLimit
```
public Long getLimit()
```
    Get 查询结果限制数量，默认20。
    
    Returns:
    
    Limit 查询结果限制数量，默认20。
  - setLimit
```
public void setLimit(Long Limit)
```
    Set 查询结果限制数量，默认20。
    
    Parameters:
    
    Limit - 查询结果限制数量，默认20。
  - getConsumerGroup
```
public String getConsumerGroup()
```
    Get 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
    
    Returns:
    
    ConsumerGroup 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
  - setConsumerGroup
```
public void setConsumerGroup(String ConsumerGroup)
```
    Set 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
    
    Parameters:
    
    ConsumerGroup - 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
  - getMsgId
```
public String getMsgId()
```
    Get 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
    
    Returns:
    
    MsgId 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
  - setMsgId
```
public void setMsgId(String MsgId)
```
    Set 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
    
    Parameters:
    
    MsgId - 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
  - getMsgKey
```
public String getMsgKey()
```
    Get 消息 Key，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
    
    Returns:
    
    MsgKey 消息 Key，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
  - setMsgKey
```
public void setMsgKey(String MsgKey)
```
    Set 消息 Key，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
    
    Parameters:
    
    MsgKey - 消息 Key，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
  - getRecentMessageNum
```
public Long getRecentMessageNum()
```
    Get 查询最近N条消息最大不超过1024，默认-1为其他查询条件
    
    Returns:
    
    RecentMessageNum 查询最近N条消息最大不超过1024，默认-1为其他查询条件
  - setRecentMessageNum
```
public void setRecentMessageNum(Long RecentMessageNum)
```
    Set 查询最近N条消息最大不超过1024，默认-1为其他查询条件
    
    Parameters:
    
    RecentMessageNum - 查询最近N条消息最大不超过1024，默认-1为其他查询条件
  - getQueryDeadLetterMessage
```
public Boolean getQueryDeadLetterMessage()
```
    Get 是否查询死信消息，默认为false
    
    Returns:
    
    QueryDeadLetterMessage 是否查询死信消息，默认为false
  - setQueryDeadLetterMessage
```
public void setQueryDeadLetterMessage(Boolean QueryDeadLetterMessage)
```
    Set 是否查询死信消息，默认为false
    
    Parameters:
    
    QueryDeadLetterMessage - 是否查询死信消息，默认为false
  - getTag
```
public String getTag()
```
    Get 消息 Tag，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
    
    Returns:
    
    Tag 消息 Tag，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
  - setTag
```
public void setTag(String Tag)
```
    Set 消息 Tag，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
    
    Parameters:
    
    Tag - 消息 Tag，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel
    
    Parameters:
    
    map - The map to populate with the model's parameters.
    
    prefix - A string prefix for the keys.

Class DescribeMessageListRequest

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

DescribeMessageListRequest

DescribeMessageListRequest

Method Detail

getInstanceId

setInstanceId

getTopic

setTopic

getStartTime

setStartTime

getEndTime

setEndTime

getTaskRequestId

setTaskRequestId

getOffset

setOffset

getLimit

setLimit

getConsumerGroup

setConsumerGroup

getMsgId

setMsgId

getMsgKey

setMsgKey

getRecentMessageNum

setRecentMessageNum

getQueryDeadLetterMessage

setQueryDeadLetterMessage

getTag

setTag

toMap