Skip to content

QueueProps

Properties for defining a Queue.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-mns-queue

Initializer

import com.aliyun.ros.cdk.mns.QueueProps;
QueueProps.builder()
    .queueName(java.lang.String)
    .queueName(IResolvable)
//  .delaySeconds(java.lang.Number)
//  .delaySeconds(IResolvable)
//  .dlqPolicy(IResolvable)
//  .dlqPolicy(DlqPolicyProperty)
//  .loggingEnabled(java.lang.Boolean)
//  .loggingEnabled(IResolvable)
//  .maximumMessageSize(java.lang.Number)
//  .maximumMessageSize(IResolvable)
//  .messageRetentionPeriod(java.lang.Number)
//  .messageRetentionPeriod(IResolvable)
//  .pollingWaitSeconds(java.lang.Number)
//  .pollingWaitSeconds(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .visibilityTimeout(java.lang.Number)
//  .visibilityTimeout(IResolvable)
    .build();

Properties

Name Type Description
queueName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property queueName: Queue name.
delaySeconds java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property delaySeconds: It is measured in seconds.
dlqPolicy com.aliyun.ros.cdk.core.IResolvable OR DlqPolicyProperty Property dlqPolicy: Dead-letter queue policy.
loggingEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property loggingEnabled: Whether to enable log management.
maximumMessageSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maximumMessageSize: Maximum body length of a message sent to the queue, measured in bytes.
messageRetentionPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property messageRetentionPeriod: The maximum time to live (TTL) for a message in the queue.
pollingWaitSeconds java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property pollingWaitSeconds: It is the maximum time that a ReceiveMessage request could be waiting for any incoming messages, while there are no message in the queue.
tags java.util.List<TagsProperty> Property tags: Tags to attach to Queue.
visibilityTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property visibilityTimeout: Duration in which a message stays in Inactive status after it is consumed from the queue.

queueNameRequired

public java.lang.Object getQueueName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property queueName: Queue name.


delaySecondsOptional

public java.lang.Object getDelaySeconds();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property delaySeconds: It is measured in seconds.

All messages sent to the queue can be consumed until the DelaySeconds expires. An integer between 0 and 604800 (7 days). The default value is 0


dlqPolicyOptional

public java.lang.Object getDlqPolicy();

Property dlqPolicy: Dead-letter queue policy.


loggingEnabledOptional

public java.lang.Object getLoggingEnabled();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property loggingEnabled: Whether to enable log management.

"true" indicates that log management is enabled, whereas "false" indicates that log management is disabled. The default value is false


maximumMessageSizeOptional

public java.lang.Object getMaximumMessageSize();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property maximumMessageSize: Maximum body length of a message sent to the queue, measured in bytes.

An integer between 1024 (1K) and 65536 (64K). The default value is 65536 (64K).


messageRetentionPeriodOptional

public java.lang.Object getMessageRetentionPeriod();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property messageRetentionPeriod: The maximum time to live (TTL) for a message in the queue.

After the specified period, the message is deleted, regardless of whether it has been retrieved. Valid values: 60 to 604800. Unit: seconds. Default value: 345600.


pollingWaitSecondsOptional

public java.lang.Object getPollingWaitSeconds();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property pollingWaitSeconds: It is the maximum time that a ReceiveMessage request could be waiting for any incoming messages, while there are no message in the queue.

Measured in seconds. An integer between 0 and 30 seconds. The default value is 0 (seconds)


tagsOptional

public java.util.List<TagsProperty> getTags();

Property tags: Tags to attach to Queue.

Max support 20 tags to add during create Queue. Each tag with two properties Key and Value, and Key is required.


visibilityTimeoutOptional

public java.lang.Object getVisibilityTimeout();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property visibilityTimeout: Duration in which a message stays in Inactive status after it is consumed from the queue.

Measured in seconds. An integer between 1 and 43200 (12 hours). The default value is 30 (seconds)