com.tencentcloudapi.tdmq.v20200217.models

Class SendBatchMessagesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tdmq.v20200217.models.SendBatchMessagesRequest

public class SendBatchMessagesRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
SendBatchMessagesRequest()
SendBatchMessagesRequest(SendBatchMessagesRequest 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
Long	getBatchingMaxBytes() Get Maximum allowed size of messages in each batch.
Long	getBatchingMaxMessages() Get Maximum number of messages in each batch.
Long	getBatchingMaxPublishDelay() Get Maximum wait time for each batch, after which the batch will be sent no matter whether the specified number or size of messages in the batch is reached.
Long	getMaxPendingMessages() Get Maximum number of produced messages which can be cached in the memory.
String	getPayload() Get Content of the message to be sent
String	getProducerName() Get Producer name, which must be globally unique.
Long	getSendTimeout() Get Message sending timeout period in seconds.
String	getStringToken() Get String-Type token, which is optional and will be automatically obtained by the system.
String	getTopic() Get Name of the topic to which to send the message.
void	setBatchingMaxBytes(Long BatchingMaxBytes) Set Maximum allowed size of messages in each batch.
void	setBatchingMaxMessages(Long BatchingMaxMessages) Set Maximum number of messages in each batch.
void	setBatchingMaxPublishDelay(Long BatchingMaxPublishDelay) Set Maximum wait time for each batch, after which the batch will be sent no matter whether the specified number or size of messages in the batch is reached.
void	setMaxPendingMessages(Long MaxPendingMessages) Set Maximum number of produced messages which can be cached in the memory.
void	setPayload(String Payload) Set Content of the message to be sent
void	setProducerName(String ProducerName) Set Producer name, which must be globally unique.
void	setSendTimeout(Long SendTimeout) Set Message sending timeout period in seconds.
void	setStringToken(String StringToken) Set String-Type token, which is optional and will be automatically obtained by the system.
void	setTopic(String Topic) Set Name of the topic to which to send the message.
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SendBatchMessagesRequest

public SendBatchMessagesRequest()

SendBatchMessagesRequest

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

getTopic

public String getTopic()

Get Name of the topic to which to send the message. It is better to be the full path of the topic, such as `tenant/namespace/topic`. If it is not specified, `public/default` will be used by default.

Returns:

Topic Name of the topic to which to send the message. It is better to be the full path of the topic, such as `tenant/namespace/topic`. If it is not specified, `public/default` will be used by default.

setTopic

public void setTopic(String Topic)

Set Name of the topic to which to send the message. It is better to be the full path of the topic, such as `tenant/namespace/topic`. If it is not specified, `public/default` will be used by default.

Parameters:

Topic - Name of the topic to which to send the message. It is better to be the full path of the topic, such as `tenant/namespace/topic`. If it is not specified, `public/default` will be used by default.

getPayload

public String getPayload()

Get Content of the message to be sent

Returns:

Payload Content of the message to be sent

setPayload

public void setPayload(String Payload)

Set Content of the message to be sent

Parameters:

Payload - Content of the message to be sent

getStringToken

public String getStringToken()

Get String-Type token, which is optional and will be automatically obtained by the system.

Returns:

StringToken String-Type token, which is optional and will be automatically obtained by the system.

setStringToken

public void setStringToken(String StringToken)

Set String-Type token, which is optional and will be automatically obtained by the system.

Parameters:

StringToken - String-Type token, which is optional and will be automatically obtained by the system.

getProducerName

public String getProducerName()

Get Producer name, which must be globally unique. If it is not configured, the system will automatically generate one.

Returns:

ProducerName Producer name, which must be globally unique. If it is not configured, the system will automatically generate one.

setProducerName

public void setProducerName(String ProducerName)

Set Producer name, which must be globally unique. If it is not configured, the system will automatically generate one.

Parameters:

ProducerName - Producer name, which must be globally unique. If it is not configured, the system will automatically generate one.

getSendTimeout

public Long getSendTimeout()

Get Message sending timeout period in seconds. Default value: 30s

Returns:

SendTimeout Message sending timeout period in seconds. Default value: 30s

setSendTimeout

public void setSendTimeout(Long SendTimeout)

Set Message sending timeout period in seconds. Default value: 30s

Parameters:

SendTimeout - Message sending timeout period in seconds. Default value: 30s

getMaxPendingMessages

public Long getMaxPendingMessages()

Get Maximum number of produced messages which can be cached in the memory. Default value: 1000

Returns:

MaxPendingMessages Maximum number of produced messages which can be cached in the memory. Default value: 1000

setMaxPendingMessages

public void setMaxPendingMessages(Long MaxPendingMessages)

Set Maximum number of produced messages which can be cached in the memory. Default value: 1000

Parameters:

MaxPendingMessages - Maximum number of produced messages which can be cached in the memory. Default value: 1000

getBatchingMaxMessages

public Long getBatchingMaxMessages()

Get Maximum number of messages in each batch. Default value: 1000 messages/batch

Returns:

BatchingMaxMessages Maximum number of messages in each batch. Default value: 1000 messages/batch

setBatchingMaxMessages

public void setBatchingMaxMessages(Long BatchingMaxMessages)

Set Maximum number of messages in each batch. Default value: 1000 messages/batch

Parameters:

BatchingMaxMessages - Maximum number of messages in each batch. Default value: 1000 messages/batch

getBatchingMaxPublishDelay

public Long getBatchingMaxPublishDelay()

Get Maximum wait time for each batch, after which the batch will be sent no matter whether the specified number or size of messages in the batch is reached. Default value: 10 ms

Returns:

BatchingMaxPublishDelay Maximum wait time for each batch, after which the batch will be sent no matter whether the specified number or size of messages in the batch is reached. Default value: 10 ms

setBatchingMaxPublishDelay

public void setBatchingMaxPublishDelay(Long BatchingMaxPublishDelay)

Set Maximum wait time for each batch, after which the batch will be sent no matter whether the specified number or size of messages in the batch is reached. Default value: 10 ms

Parameters:

BatchingMaxPublishDelay - Maximum wait time for each batch, after which the batch will be sent no matter whether the specified number or size of messages in the batch is reached. Default value: 10 ms

getBatchingMaxBytes

public Long getBatchingMaxBytes()

Get Maximum allowed size of messages in each batch. Default value: 128 KB

Returns:

BatchingMaxBytes Maximum allowed size of messages in each batch. Default value: 128 KB

setBatchingMaxBytes

public void setBatchingMaxBytes(Long BatchingMaxBytes)

Set Maximum allowed size of messages in each batch. Default value: 128 KB

Parameters:

BatchingMaxBytes - Maximum allowed size of messages in each batch. Default value: 128 KB

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel