com.tencentcloudapi.mqtt.v20240516.models

Class PublishMessageRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.mqtt.v20240516.models.PublishMessageRequest

public class PublishMessageRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
PublishMessageRequest()
PublishMessageRequest(PublishMessageRequest 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

Modifier and Type	Method and Description
String	getEncoding() Get 消息 payload 编码，可选 plain 或 base64，默认为 plain（即不编码）
String	getInstanceId() Get 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
String	getPayload() Get 消息负载 Payload，是消息的实际内容，需要按 encoding 指定的编码方式进行编码
Long	getQos() Get 消息的服务质量等级，默认为 1 QoS 0（至多一次）消息发送后，不保证接收方一定收到，也不要求接收方确认。 QoS 1（至少一次）消息至少被接收方成功接收一次，但可能重复。 QoS 2（恰好一次）消息确保被接收方接收且仅接收一次，无重复。
Boolean	getRetain() Get 是否为保留消息，默认为 false，且仅支持发布到主题的消息设置为 true
String	getTargetClientId() Get 消息目的客户端 ID，该参数与 TargetTopic 二选一
String	getTargetTopic() Get 消息目的主题，该参数与 TargetClientId 二选一
void	setEncoding(String Encoding) Set 消息 payload 编码，可选 plain 或 base64，默认为 plain（即不编码）
void	setInstanceId(String InstanceId) Set 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
void	setPayload(String Payload) Set 消息负载 Payload，是消息的实际内容，需要按 encoding 指定的编码方式进行编码
void	setQos(Long Qos) Set 消息的服务质量等级，默认为 1 QoS 0（至多一次）消息发送后，不保证接收方一定收到，也不要求接收方确认。 QoS 1（至少一次）消息至少被接收方成功接收一次，但可能重复。 QoS 2（恰好一次）消息确保被接收方接收且仅接收一次，无重复。
void	setRetain(Boolean Retain) Set 是否为保留消息，默认为 false，且仅支持发布到主题的消息设置为 true
void	setTargetClientId(String TargetClientId) Set 消息目的客户端 ID，该参数与 TargetTopic 二选一
void	setTargetTopic(String TargetTopic) Set 消息目的主题，该参数与 TargetClientId 二选一
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

PublishMessageRequest

public PublishMessageRequest()

PublishMessageRequest

public PublishMessageRequest(PublishMessageRequest 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 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。

Returns:

InstanceId 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。

setInstanceId

public void setInstanceId(String InstanceId)

Set 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。

Parameters:

InstanceId - 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。

getPayload

public String getPayload()

Get 消息负载 Payload，是消息的实际内容，需要按 encoding 指定的编码方式进行编码

Returns:

Payload 消息负载 Payload，是消息的实际内容，需要按 encoding 指定的编码方式进行编码

setPayload

public void setPayload(String Payload)

Set 消息负载 Payload，是消息的实际内容，需要按 encoding 指定的编码方式进行编码

Parameters:

Payload - 消息负载 Payload，是消息的实际内容，需要按 encoding 指定的编码方式进行编码

getTargetTopic

public String getTargetTopic()

Get 消息目的主题，该参数与 TargetClientId 二选一

Returns:

TargetTopic 消息目的主题，该参数与 TargetClientId 二选一

setTargetTopic

public void setTargetTopic(String TargetTopic)

Set 消息目的主题，该参数与 TargetClientId 二选一

Parameters:

TargetTopic - 消息目的主题，该参数与 TargetClientId 二选一

getTargetClientId

public String getTargetClientId()

Get 消息目的客户端 ID，该参数与 TargetTopic 二选一

Returns:

TargetClientId 消息目的客户端 ID，该参数与 TargetTopic 二选一

setTargetClientId

public void setTargetClientId(String TargetClientId)

Set 消息目的客户端 ID，该参数与 TargetTopic 二选一

Parameters:

TargetClientId - 消息目的客户端 ID，该参数与 TargetTopic 二选一

getEncoding

public String getEncoding()

Get 消息 payload 编码，可选 plain 或 base64，默认为 plain（即不编码）

Returns:

Encoding 消息 payload 编码，可选 plain 或 base64，默认为 plain（即不编码）

setEncoding

public void setEncoding(String Encoding)

Set 消息 payload 编码，可选 plain 或 base64，默认为 plain（即不编码）

Parameters:

Encoding - 消息 payload 编码，可选 plain 或 base64，默认为 plain（即不编码）

getQos

public Long getQos()

Get 消息的服务质量等级，默认为 1 QoS 0（至多一次）消息发送后，不保证接收方一定收到，也不要求接收方确认。 QoS 1（至少一次）消息至少被接收方成功接收一次，但可能重复。 QoS 2（恰好一次）消息确保被接收方接收且仅接收一次，无重复。

Returns:

Qos 消息的服务质量等级，默认为 1 QoS 0（至多一次）消息发送后，不保证接收方一定收到，也不要求接收方确认。 QoS 1（至少一次）消息至少被接收方成功接收一次，但可能重复。 QoS 2（恰好一次）消息确保被接收方接收且仅接收一次，无重复。

setQos

public void setQos(Long Qos)

Set 消息的服务质量等级，默认为 1 QoS 0（至多一次）消息发送后，不保证接收方一定收到，也不要求接收方确认。 QoS 1（至少一次）消息至少被接收方成功接收一次，但可能重复。 QoS 2（恰好一次）消息确保被接收方接收且仅接收一次，无重复。

Parameters:

Qos - 消息的服务质量等级，默认为 1 QoS 0（至多一次）消息发送后，不保证接收方一定收到，也不要求接收方确认。 QoS 1（至少一次）消息至少被接收方成功接收一次，但可能重复。 QoS 2（恰好一次）消息确保被接收方接收且仅接收一次，无重复。

getRetain

public Boolean getRetain()

Get 是否为保留消息，默认为 false，且仅支持发布到主题的消息设置为 true

Returns:

Retain 是否为保留消息，默认为 false，且仅支持发布到主题的消息设置为 true

setRetain

public void setRetain(Boolean Retain)

Set 是否为保留消息，默认为 false，且仅支持发布到主题的消息设置为 true

Parameters:

Retain - 是否为保留消息，默认为 false，且仅支持发布到主题的消息设置为 true

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.