com.tencentcloudapi.tdmq.v20200217.models

Class ReceiveMessageRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tdmq.v20200217.models.ReceiveMessageRequest

public class ReceiveMessageRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ReceiveMessageRequest()
ReceiveMessageRequest(ReceiveMessageRequest 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	getMaxNumBytes() Get 用于设置BatchReceivePolicy，指在一次batch中最多接收的消息体有多大，单位是 bytes。默认是 0，即不开启BatchReceivePolicy
Long	getMaxNumMessages() Get 用于设置BatchReceivePolicy，指在一次batch中最多接收多少条消息，默认是 0。即不开启BatchReceivePolicy
Long	getReceiverQueueSize() Get 默认值为1000，consumer接收的消息会首先存储到receiverQueueSize这个队列中，用作调优接收消息的速率
String	getSubInitialPosition() Get 默认值为：Earliest。用作判定consumer初始接收消息的位置，可选参数为：Earliest, Latest
String	getSubscriptionName() Get 订阅者的名字
Long	getTimeout() Get 用于设置BatchReceivePolicy，指在一次batch消息的接收z中最多等待的超时时间，单位是毫秒。默认是 0，即不开启BatchReceivePolicy
String	getTopic() Get 接收消息的topic的名字, 这里尽量需要使用topic的全路径，如果不指定，即：tenant/namespace/topic。默认使用的是：public/default
void	setMaxNumBytes(Long MaxNumBytes) Set 用于设置BatchReceivePolicy，指在一次batch中最多接收的消息体有多大，单位是 bytes。默认是 0，即不开启BatchReceivePolicy
void	setMaxNumMessages(Long MaxNumMessages) Set 用于设置BatchReceivePolicy，指在一次batch中最多接收多少条消息，默认是 0。即不开启BatchReceivePolicy
void	setReceiverQueueSize(Long ReceiverQueueSize) Set 默认值为1000，consumer接收的消息会首先存储到receiverQueueSize这个队列中，用作调优接收消息的速率
void	setSubInitialPosition(String SubInitialPosition) Set 默认值为：Earliest。用作判定consumer初始接收消息的位置，可选参数为：Earliest, Latest
void	setSubscriptionName(String SubscriptionName) Set 订阅者的名字
void	setTimeout(Long Timeout) Set 用于设置BatchReceivePolicy，指在一次batch消息的接收z中最多等待的超时时间，单位是毫秒。默认是 0，即不开启BatchReceivePolicy
void	setTopic(String Topic) Set 接收消息的topic的名字, 这里尽量需要使用topic的全路径，如果不指定，即：tenant/namespace/topic。默认使用的是：public/default
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

ReceiveMessageRequest

public ReceiveMessageRequest()

ReceiveMessageRequest

public ReceiveMessageRequest(ReceiveMessageRequest 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 接收消息的topic的名字, 这里尽量需要使用topic的全路径，如果不指定，即：tenant/namespace/topic。默认使用的是：public/default

Returns:

Topic 接收消息的topic的名字, 这里尽量需要使用topic的全路径，如果不指定，即：tenant/namespace/topic。默认使用的是：public/default

setTopic

public void setTopic(String Topic)

Set 接收消息的topic的名字, 这里尽量需要使用topic的全路径，如果不指定，即：tenant/namespace/topic。默认使用的是：public/default

Parameters:

Topic - 接收消息的topic的名字, 这里尽量需要使用topic的全路径，如果不指定，即：tenant/namespace/topic。默认使用的是：public/default

getSubscriptionName

public String getSubscriptionName()

Get 订阅者的名字

Returns:

SubscriptionName 订阅者的名字

setSubscriptionName

public void setSubscriptionName(String SubscriptionName)

Set 订阅者的名字

Parameters:

SubscriptionName - 订阅者的名字

getReceiverQueueSize

public Long getReceiverQueueSize()

Get 默认值为1000，consumer接收的消息会首先存储到receiverQueueSize这个队列中，用作调优接收消息的速率

Returns:

ReceiverQueueSize 默认值为1000，consumer接收的消息会首先存储到receiverQueueSize这个队列中，用作调优接收消息的速率

setReceiverQueueSize

public void setReceiverQueueSize(Long ReceiverQueueSize)

Set 默认值为1000，consumer接收的消息会首先存储到receiverQueueSize这个队列中，用作调优接收消息的速率

Parameters:

ReceiverQueueSize - 默认值为1000，consumer接收的消息会首先存储到receiverQueueSize这个队列中，用作调优接收消息的速率

getSubInitialPosition

public String getSubInitialPosition()

Get 默认值为：Earliest。用作判定consumer初始接收消息的位置，可选参数为：Earliest, Latest

Returns:

SubInitialPosition 默认值为：Earliest。用作判定consumer初始接收消息的位置，可选参数为：Earliest, Latest

setSubInitialPosition

public void setSubInitialPosition(String SubInitialPosition)

Set 默认值为：Earliest。用作判定consumer初始接收消息的位置，可选参数为：Earliest, Latest

Parameters:

SubInitialPosition - 默认值为：Earliest。用作判定consumer初始接收消息的位置，可选参数为：Earliest, Latest

getMaxNumMessages

public Long getMaxNumMessages()

Get 用于设置BatchReceivePolicy，指在一次batch中最多接收多少条消息，默认是 0。即不开启BatchReceivePolicy

Returns:

MaxNumMessages 用于设置BatchReceivePolicy，指在一次batch中最多接收多少条消息，默认是 0。即不开启BatchReceivePolicy

setMaxNumMessages

public void setMaxNumMessages(Long MaxNumMessages)

Set 用于设置BatchReceivePolicy，指在一次batch中最多接收多少条消息，默认是 0。即不开启BatchReceivePolicy

Parameters:

MaxNumMessages - 用于设置BatchReceivePolicy，指在一次batch中最多接收多少条消息，默认是 0。即不开启BatchReceivePolicy

getMaxNumBytes

public Long getMaxNumBytes()

Get 用于设置BatchReceivePolicy，指在一次batch中最多接收的消息体有多大，单位是 bytes。默认是 0，即不开启BatchReceivePolicy

Returns:

MaxNumBytes 用于设置BatchReceivePolicy，指在一次batch中最多接收的消息体有多大，单位是 bytes。默认是 0，即不开启BatchReceivePolicy

setMaxNumBytes

public void setMaxNumBytes(Long MaxNumBytes)

Set 用于设置BatchReceivePolicy，指在一次batch中最多接收的消息体有多大，单位是 bytes。默认是 0，即不开启BatchReceivePolicy

Parameters:

MaxNumBytes - 用于设置BatchReceivePolicy，指在一次batch中最多接收的消息体有多大，单位是 bytes。默认是 0，即不开启BatchReceivePolicy

getTimeout

public Long getTimeout()

Get 用于设置BatchReceivePolicy，指在一次batch消息的接收z中最多等待的超时时间，单位是毫秒。默认是 0，即不开启BatchReceivePolicy

Returns:

Timeout 用于设置BatchReceivePolicy，指在一次batch消息的接收z中最多等待的超时时间，单位是毫秒。默认是 0，即不开启BatchReceivePolicy

setTimeout

public void setTimeout(Long Timeout)

Set 用于设置BatchReceivePolicy，指在一次batch消息的接收z中最多等待的超时时间，单位是毫秒。默认是 0，即不开启BatchReceivePolicy

Parameters:

Timeout - 用于设置BatchReceivePolicy，指在一次batch消息的接收z中最多等待的超时时间，单位是毫秒。默认是 0，即不开启BatchReceivePolicy

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.