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 This parameter is used to specify the maximum body size (in bytes) of received messages in a batch for `BatchReceivePolicy`.
Long	getMaxNumMessages() Get This parameter is used to specify the maximum number of received messages in a batch for `BatchReceivePolicy`.
Long	getReceiverQueueSize() Get Default value: 1000.
String	getSubInitialPosition() Get A parameter used to determine the position where the consumer initially receives messages.
String	getSubscriptionName() Get Subscriber name
Long	getTimeout() Get This parameter is used to specify the maximum wait timeout (in milliseconds) for receiving a batch of messages for `BatchReceivePolicy`.
String	getTopic() Get Name of the topic which receives the message.
void	setMaxNumBytes(Long MaxNumBytes) Set This parameter is used to specify the maximum body size (in bytes) of received messages in a batch for `BatchReceivePolicy`.
void	setMaxNumMessages(Long MaxNumMessages) Set This parameter is used to specify the maximum number of received messages in a batch for `BatchReceivePolicy`.
void	setReceiverQueueSize(Long ReceiverQueueSize) Set Default value: 1000.
void	setSubInitialPosition(String SubInitialPosition) Set A parameter used to determine the position where the consumer initially receives messages.
void	setSubscriptionName(String SubscriptionName) Set Subscriber name
void	setTimeout(Long Timeout) Set This parameter is used to specify the maximum wait timeout (in milliseconds) for receiving a batch of messages for `BatchReceivePolicy`.
void	setTopic(String Topic) Set Name of the topic which receives 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, GetHeader, getMultipartRequestParams, getSkipSign, 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 Name of the topic which receives 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 which receives 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 which receives 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 which receives 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.

getSubscriptionName

public String getSubscriptionName()

Get Subscriber name

Returns:

SubscriptionName Subscriber name

setSubscriptionName

public void setSubscriptionName(String SubscriptionName)

Set Subscriber name

Parameters:

SubscriptionName - Subscriber name

getReceiverQueueSize

public Long getReceiverQueueSize()

Get Default value: 1000. Messages received by the consumer will first be stored in the `receiverQueueSize` queue to tune the message receiving rate.

Returns:

ReceiverQueueSize Default value: 1000. Messages received by the consumer will first be stored in the `receiverQueueSize` queue to tune the message receiving rate.

setReceiverQueueSize

public void setReceiverQueueSize(Long ReceiverQueueSize)

Set Default value: 1000. Messages received by the consumer will first be stored in the `receiverQueueSize` queue to tune the message receiving rate.

Parameters:

ReceiverQueueSize - Default value: 1000. Messages received by the consumer will first be stored in the `receiverQueueSize` queue to tune the message receiving rate.

getSubInitialPosition

public String getSubInitialPosition()

Get A parameter used to determine the position where the consumer initially receives messages. Valid values: `Earliest` (default), `Latest`.

Returns:

SubInitialPosition A parameter used to determine the position where the consumer initially receives messages. Valid values: `Earliest` (default), `Latest`.

setSubInitialPosition

public void setSubInitialPosition(String SubInitialPosition)

Set A parameter used to determine the position where the consumer initially receives messages. Valid values: `Earliest` (default), `Latest`.

Parameters:

SubInitialPosition - A parameter used to determine the position where the consumer initially receives messages. Valid values: `Earliest` (default), `Latest`.

getMaxNumMessages

public Long getMaxNumMessages()

Get This parameter is used to specify the maximum number of received messages in a batch for `BatchReceivePolicy`. The default value is 0, indicating that `BatchReceivePolicy` is disabled.

Returns:

MaxNumMessages This parameter is used to specify the maximum number of received messages in a batch for `BatchReceivePolicy`. The default value is 0, indicating that `BatchReceivePolicy` is disabled.

setMaxNumMessages

public void setMaxNumMessages(Long MaxNumMessages)

Set This parameter is used to specify the maximum number of received messages in a batch for `BatchReceivePolicy`. The default value is 0, indicating that `BatchReceivePolicy` is disabled.

Parameters:

MaxNumMessages - This parameter is used to specify the maximum number of received messages in a batch for `BatchReceivePolicy`. The default value is 0, indicating that `BatchReceivePolicy` is disabled.

getMaxNumBytes

public Long getMaxNumBytes()

Get This parameter is used to specify the maximum body size (in bytes) of received messages in a batch for `BatchReceivePolicy`. The default value is 0, indicating that `BatchReceivePolicy` is disabled.

Returns:

MaxNumBytes This parameter is used to specify the maximum body size (in bytes) of received messages in a batch for `BatchReceivePolicy`. The default value is 0, indicating that `BatchReceivePolicy` is disabled.

setMaxNumBytes

public void setMaxNumBytes(Long MaxNumBytes)

Set This parameter is used to specify the maximum body size (in bytes) of received messages in a batch for `BatchReceivePolicy`. The default value is 0, indicating that `BatchReceivePolicy` is disabled.

Parameters:

MaxNumBytes - This parameter is used to specify the maximum body size (in bytes) of received messages in a batch for `BatchReceivePolicy`. The default value is 0, indicating that `BatchReceivePolicy` is disabled.

getTimeout

public Long getTimeout()

Get This parameter is used to specify the maximum wait timeout (in milliseconds) for receiving a batch of messages for `BatchReceivePolicy`. The default value is 0, indicating that `BatchReceivePolicy` is disabled.

Returns:

Timeout This parameter is used to specify the maximum wait timeout (in milliseconds) for receiving a batch of messages for `BatchReceivePolicy`. The default value is 0, indicating that `BatchReceivePolicy` is disabled.

setTimeout

public void setTimeout(Long Timeout)

Set This parameter is used to specify the maximum wait timeout (in milliseconds) for receiving a batch of messages for `BatchReceivePolicy`. The default value is 0, indicating that `BatchReceivePolicy` is disabled.

Parameters:

Timeout - This parameter is used to specify the maximum wait timeout (in milliseconds) for receiving a batch of messages for `BatchReceivePolicy`. The default value is 0, indicating that `BatchReceivePolicy` is disabled.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel