public class DescribeMessageDetailsResponse extends AbstractModel
header, skipSign
Constructor and Description |
---|
DescribeMessageDetailsResponse() |
DescribeMessageDetailsResponse(DescribeMessageDetailsResponse 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.
|
Modifier and Type | Method and Description |
---|---|
String |
getBody()
Get 消息体
|
String |
getClientId()
Get 生产者地址
|
String |
getContentType()
Get 内容类型(MQTT5)
含义:指示消息载荷的内容类型,使用标准的 MIME 类型格式。这帮助接收方正确解析和处理消息内容。
示例:
application/json:表示载荷是 JSON 格式的数据。
text/plain:表示载荷是纯文本。
application/octet-stream:表示载荷是二进制数据。
|
String |
getCorrelationData()
Get 关联数据(MQTT5)
含义:用于关联请求和响应的标识符,通常是一个字节数组。在请求 - 响应模式中,发送方设置此值,接收方在响应中包含相同的值,以便发送方识别响应对应的请求。
示例:
发送方生成一个唯一 ID(如 UUID 的字节数组)作为CorrelationData,附加到请求消息中。
接收方在响应消息中包含相同的CorrelationData,发送方通过比较此值来匹配响应和请求。
|
Long |
getMessageExpiryInterval()
Get 消息过期间隔(MQTT5)
含义:指定消息在被丢弃前的有效时间(秒)。如果消息在过期前未能送达,则会被 MQTT 服务器丢弃。
示例:
值为60:表示消息在发布后的 60 秒内有效,过期后未送达则被丢弃。
值为0:表示消息不过期,永久有效(直到被接收或会话结束)。
|
String |
getMessageId()
Get 消息ID
|
String |
getOriginTopic()
Get 源topic
|
Long |
getPayloadFormatIndicator()
Get 载荷格式指示符(MQTT5)
含义:指示载荷的格式,是一个布尔值。0表示未指定格式(二进制),1表示 UTF-8 编码的字符串。
示例:
值为0:当载荷是二进制数据,如图片、音频等。
值为1:当载荷是 UTF-8 编码的文本,如 JSON 字符串、XML 等。
|
String |
getQos()
Get Topic
|
String |
getRequestId()
Get 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
String |
getResponseTopic()
Get 响应主题(MQTT5)
含义:指定一个主题,用于请求 - 响应模式中的响应消息。发送方可以指定接收方应该将响应发送到哪个主题。
示例:
发送方发布请求到主题devices/device1/commands,并设置ResponseTopic为devices/device1/responses。
接收方处理请求后,将响应发布到devices/device1/responses主题。
|
Long |
getStoreTimestamp()
Get 消息存储时间,毫秒级时间戳。
|
String |
getSubscriptionIdentifier()
Get 订阅标识符(MQTT5)
含义:为订阅分配的唯一标识符,用于标识客户端的特定订阅。当服务器向客户端发送消息时,可以包含此标识符,帮助客户端识别消息对应的订阅。
示例:
客户端订阅主题devices/+/temperature,并设置SubscriptionIdentifier为123。
当服务器向客户端发送此主题的消息时,会在消息中包含SubscriptionIdentifier: 123,客户端可以根据此值知道消息是通过哪个订阅接收的。
|
UserProperty[] |
getUserProperties()
Get 用户自定义属性
|
void |
setBody(String Body)
Set 消息体
|
void |
setClientId(String ClientId)
Set 生产者地址
|
void |
setContentType(String ContentType)
Set 内容类型(MQTT5)
含义:指示消息载荷的内容类型,使用标准的 MIME 类型格式。这帮助接收方正确解析和处理消息内容。
示例:
application/json:表示载荷是 JSON 格式的数据。
text/plain:表示载荷是纯文本。
application/octet-stream:表示载荷是二进制数据。
|
void |
setCorrelationData(String CorrelationData)
Set 关联数据(MQTT5)
含义:用于关联请求和响应的标识符,通常是一个字节数组。在请求 - 响应模式中,发送方设置此值,接收方在响应中包含相同的值,以便发送方识别响应对应的请求。
示例:
发送方生成一个唯一 ID(如 UUID 的字节数组)作为CorrelationData,附加到请求消息中。
接收方在响应消息中包含相同的CorrelationData,发送方通过比较此值来匹配响应和请求。
|
void |
setMessageExpiryInterval(Long MessageExpiryInterval)
Set 消息过期间隔(MQTT5)
含义:指定消息在被丢弃前的有效时间(秒)。如果消息在过期前未能送达,则会被 MQTT 服务器丢弃。
示例:
值为60:表示消息在发布后的 60 秒内有效,过期后未送达则被丢弃。
值为0:表示消息不过期,永久有效(直到被接收或会话结束)。
|
void |
setMessageId(String MessageId)
Set 消息ID
|
void |
setOriginTopic(String OriginTopic)
Set 源topic
|
void |
setPayloadFormatIndicator(Long PayloadFormatIndicator)
Set 载荷格式指示符(MQTT5)
含义:指示载荷的格式,是一个布尔值。0表示未指定格式(二进制),1表示 UTF-8 编码的字符串。
示例:
值为0:当载荷是二进制数据,如图片、音频等。
值为1:当载荷是 UTF-8 编码的文本,如 JSON 字符串、XML 等。
|
void |
setQos(String Qos)
Set Topic
|
void |
setRequestId(String RequestId)
Set 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
void |
setResponseTopic(String ResponseTopic)
Set 响应主题(MQTT5)
含义:指定一个主题,用于请求 - 响应模式中的响应消息。发送方可以指定接收方应该将响应发送到哪个主题。
示例:
发送方发布请求到主题devices/device1/commands,并设置ResponseTopic为devices/device1/responses。
接收方处理请求后,将响应发布到devices/device1/responses主题。
|
void |
setStoreTimestamp(Long StoreTimestamp)
Set 消息存储时间,毫秒级时间戳。
|
void |
setSubscriptionIdentifier(String SubscriptionIdentifier)
Set 订阅标识符(MQTT5)
含义:为订阅分配的唯一标识符,用于标识客户端的特定订阅。当服务器向客户端发送消息时,可以包含此标识符,帮助客户端识别消息对应的订阅。
示例:
客户端订阅主题devices/+/temperature,并设置SubscriptionIdentifier为123。
当服务器向客户端发送此主题的消息时,会在消息中包含SubscriptionIdentifier: 123,客户端可以根据此值知道消息是通过哪个订阅接收的。
|
void |
setUserProperties(UserProperty[] UserProperties)
Set 用户自定义属性
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public DescribeMessageDetailsResponse()
public DescribeMessageDetailsResponse(DescribeMessageDetailsResponse source)
public String getBody()
public void setBody(String Body)
Body
- 消息体public UserProperty[] getUserProperties()
public void setUserProperties(UserProperty[] UserProperties)
UserProperties
- 用户自定义属性public Long getStoreTimestamp()
public void setStoreTimestamp(Long StoreTimestamp)
StoreTimestamp
- 消息存储时间,毫秒级时间戳。public String getMessageId()
public void setMessageId(String MessageId)
MessageId
- 消息IDpublic String getClientId()
public void setClientId(String ClientId)
ClientId
- 生产者地址public String getQos()
public void setQos(String Qos)
Qos
- Topicpublic String getOriginTopic()
public void setOriginTopic(String OriginTopic)
OriginTopic
- 源topicpublic String getContentType()
public void setContentType(String ContentType)
ContentType
- 内容类型(MQTT5)
含义:指示消息载荷的内容类型,使用标准的 MIME 类型格式。这帮助接收方正确解析和处理消息内容。
示例:
application/json:表示载荷是 JSON 格式的数据。
text/plain:表示载荷是纯文本。
application/octet-stream:表示载荷是二进制数据。public Long getPayloadFormatIndicator()
public void setPayloadFormatIndicator(Long PayloadFormatIndicator)
PayloadFormatIndicator
- 载荷格式指示符(MQTT5)
含义:指示载荷的格式,是一个布尔值。0表示未指定格式(二进制),1表示 UTF-8 编码的字符串。
示例:
值为0:当载荷是二进制数据,如图片、音频等。
值为1:当载荷是 UTF-8 编码的文本,如 JSON 字符串、XML 等。public Long getMessageExpiryInterval()
public void setMessageExpiryInterval(Long MessageExpiryInterval)
MessageExpiryInterval
- 消息过期间隔(MQTT5)
含义:指定消息在被丢弃前的有效时间(秒)。如果消息在过期前未能送达,则会被 MQTT 服务器丢弃。
示例:
值为60:表示消息在发布后的 60 秒内有效,过期后未送达则被丢弃。
值为0:表示消息不过期,永久有效(直到被接收或会话结束)。public String getResponseTopic()
public void setResponseTopic(String ResponseTopic)
ResponseTopic
- 响应主题(MQTT5)
含义:指定一个主题,用于请求 - 响应模式中的响应消息。发送方可以指定接收方应该将响应发送到哪个主题。
示例:
发送方发布请求到主题devices/device1/commands,并设置ResponseTopic为devices/device1/responses。
接收方处理请求后,将响应发布到devices/device1/responses主题。public String getCorrelationData()
public void setCorrelationData(String CorrelationData)
CorrelationData
- 关联数据(MQTT5)
含义:用于关联请求和响应的标识符,通常是一个字节数组。在请求 - 响应模式中,发送方设置此值,接收方在响应中包含相同的值,以便发送方识别响应对应的请求。
示例:
发送方生成一个唯一 ID(如 UUID 的字节数组)作为CorrelationData,附加到请求消息中。
接收方在响应消息中包含相同的CorrelationData,发送方通过比较此值来匹配响应和请求。public String getSubscriptionIdentifier()
public void setSubscriptionIdentifier(String SubscriptionIdentifier)
SubscriptionIdentifier
- 订阅标识符(MQTT5)
含义:为订阅分配的唯一标识符,用于标识客户端的特定订阅。当服务器向客户端发送消息时,可以包含此标识符,帮助客户端识别消息对应的订阅。
示例:
客户端订阅主题devices/+/temperature,并设置SubscriptionIdentifier为123。
当服务器向客户端发送此主题的消息时,会在消息中包含SubscriptionIdentifier: 123,客户端可以根据此值知道消息是通过哪个订阅接收的。public String getRequestId()
public void setRequestId(String RequestId)
RequestId
- 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。Copyright © 2025. All rights reserved.