com.tencentcloudapi.tdmq.v20200217.models

Class ReceiveMessageResponse

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tdmq.v20200217.models.ReceiveMessageResponse

public class ReceiveMessageResponse
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ReceiveMessageResponse()
ReceiveMessageResponse(ReceiveMessageResponse 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	getAckTopic() Get Provided to the `Ack` API and used to acknowledge messages in the topic
String	getErrorMsg() Get Returned error message.
String	getMessageID() Get Unique primary key used to identify the message
String	getMessageIDList() Get MessageIDs returned by `BatchReceivePolicy` at a time, which are separated by “###”.
String	getMessagePayload() Get Content of the received message
String	getMessagesPayload() Get Message contents returned by `BatchReceivePolicy` at a time, which are separated by “###”.
String	getRequestId() Get The unique request ID, which is returned for each request.
String	getSubName() Get Returned subscriber name, which will be used when an acknowledgment consumer is created.
void	setAckTopic(String AckTopic) Set Provided to the `Ack` API and used to acknowledge messages in the topic
void	setErrorMsg(String ErrorMsg) Set Returned error message.
void	setMessageID(String MessageID) Set Unique primary key used to identify the message
void	setMessageIDList(String MessageIDList) Set MessageIDs returned by `BatchReceivePolicy` at a time, which are separated by “###”.
void	setMessagePayload(String MessagePayload) Set Content of the received message
void	setMessagesPayload(String MessagesPayload) Set Message contents returned by `BatchReceivePolicy` at a time, which are separated by “###”.
void	setRequestId(String RequestId) Set The unique request ID, which is returned for each request.
void	setSubName(String SubName) Set Returned subscriber name, which will be used when an acknowledgment consumer is created.
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

ReceiveMessageResponse

public ReceiveMessageResponse()

ReceiveMessageResponse

public ReceiveMessageResponse(ReceiveMessageResponse 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

getMessageID

public String getMessageID()

Get Unique primary key used to identify the message

Returns:

MessageID Unique primary key used to identify the message

setMessageID

public void setMessageID(String MessageID)

Set Unique primary key used to identify the message

Parameters:

MessageID - Unique primary key used to identify the message

getMessagePayload

public String getMessagePayload()

Get Content of the received message

Returns:

MessagePayload Content of the received message

setMessagePayload

public void setMessagePayload(String MessagePayload)

Set Content of the received message

Parameters:

MessagePayload - Content of the received message

getAckTopic

public String getAckTopic()

Get Provided to the `Ack` API and used to acknowledge messages in the topic

Returns:

AckTopic Provided to the `Ack` API and used to acknowledge messages in the topic

setAckTopic

public void setAckTopic(String AckTopic)

Set Provided to the `Ack` API and used to acknowledge messages in the topic

Parameters:

AckTopic - Provided to the `Ack` API and used to acknowledge messages in the topic

getErrorMsg

public String getErrorMsg()

Get Returned error message. If it is an empty string, no error occurred. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ErrorMsg Returned error message. If it is an empty string, no error occurred. Note: this field may return null, indicating that no valid values can be obtained.

setErrorMsg

public void setErrorMsg(String ErrorMsg)

Set Returned error message. If it is an empty string, no error occurred. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ErrorMsg - Returned error message. If it is an empty string, no error occurred. Note: this field may return null, indicating that no valid values can be obtained.

getSubName

public String getSubName()

Get Returned subscriber name, which will be used when an acknowledgment consumer is created. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

SubName Returned subscriber name, which will be used when an acknowledgment consumer is created. Note: this field may return null, indicating that no valid values can be obtained.

setSubName

public void setSubName(String SubName)

Set Returned subscriber name, which will be used when an acknowledgment consumer is created. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

SubName - Returned subscriber name, which will be used when an acknowledgment consumer is created. Note: this field may return null, indicating that no valid values can be obtained.

getMessageIDList

public String getMessageIDList()

Get MessageIDs returned by `BatchReceivePolicy` at a time, which are separated by “###”. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

MessageIDList MessageIDs returned by `BatchReceivePolicy` at a time, which are separated by “###”. Note: This field may return null, indicating that no valid values can be obtained.

setMessageIDList

public void setMessageIDList(String MessageIDList)

Set MessageIDs returned by `BatchReceivePolicy` at a time, which are separated by “###”. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

MessageIDList - MessageIDs returned by `BatchReceivePolicy` at a time, which are separated by “###”. Note: This field may return null, indicating that no valid values can be obtained.

getMessagesPayload

public String getMessagesPayload()

Get Message contents returned by `BatchReceivePolicy` at a time, which are separated by “###”. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

MessagesPayload Message contents returned by `BatchReceivePolicy` at a time, which are separated by “###”. Note: This field may return null, indicating that no valid values can be obtained.

setMessagesPayload

public void setMessagesPayload(String MessagesPayload)

Set Message contents returned by `BatchReceivePolicy` at a time, which are separated by “###”. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

MessagesPayload - Message contents returned by `BatchReceivePolicy` at a time, which are separated by “###”. Note: This field may return null, indicating that no valid values can be obtained.

getRequestId

public String getRequestId()

Get The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Returns:

RequestId The unique request ID, which is returned for each request. RequestId is required for locating a problem.

setRequestId

public void setRequestId(String RequestId)

Set The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Parameters:

RequestId - The unique request ID, which is returned for each request. RequestId is required for locating a problem.

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.