Queue

This class encapsulates and extends the ROS resource type DATASOURCE::MNS::Queue, which is used to query the information about a created queue.

Initializers

import com.aliyun.ros.cdk.mns.datasource.Queue;
Queue.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .queueName(java.lang.String)
    .queueName(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No description.
queueName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property queueName: The name of the MNS queue.
refreshOptions	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

---

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

queueName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property queueName: The name of the MNS queue.

---

refreshOptions^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

---

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

---

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

Name	Description
isConstruct	Return whether the given object is a Construct.

---

isConstruct

import com.aliyun.ros.cdk.mns.datasource.Queue;
Queue.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

Properties

Name	Type	Description
node	com.aliyun.ros.cdk.core.ConstructNode	The construct tree node associated with this construct.
ref	java.lang.String	No description.
stack	com.aliyun.ros.cdk.core.Stack	The stack in which this resource is defined.
resource	com.aliyun.ros.cdk.core.RosResource	No description.
attrActiveMessages	com.aliyun.ros.cdk.core.IResolvable	Attribute ActiveMessages: The total number of active messages in the queue.
attrCreateTime	com.aliyun.ros.cdk.core.IResolvable	Attribute CreateTime: The time when the queue was created.
attrDelayMessages	com.aliyun.ros.cdk.core.IResolvable	Attribute DelayMessages: The total number of delayed messages in the queue.
attrDelaySeconds	com.aliyun.ros.cdk.core.IResolvable	Attribute DelaySeconds: The delay time after which all messages that are sent to the queue can be consumed.
attrInactiveMessages	com.aliyun.ros.cdk.core.IResolvable	Attribute InactiveMessages: The total number of inactive messages in the queue.
attrLastModifyTime	com.aliyun.ros.cdk.core.IResolvable	Attribute LastModifyTime: The most recent time when the queue was modified.
attrLoggingEnabled	com.aliyun.ros.cdk.core.IResolvable	Attribute LoggingEnabled: Specifies whether to enable the log management feature.
attrMaximumMessageSize	com.aliyun.ros.cdk.core.IResolvable	Attribute MaximumMessageSize: The maximum size of a message that can be sent to the queue.
attrMessageRetentionPeriod	com.aliyun.ros.cdk.core.IResolvable	Attribute MessageRetentionPeriod: The maximum lifetime of a message in the queue.
attrPollingWaitSeconds	com.aliyun.ros.cdk.core.IResolvable	Attribute PollingWaitSeconds: The maximum time period that a ReceiveMessage request can wait till a message is in the queue.
attrQueueInternalUrl	com.aliyun.ros.cdk.core.IResolvable	Attribute QueueInternalUrl: The internal URL of the queue.
attrQueueName	com.aliyun.ros.cdk.core.IResolvable	Attribute QueueName: The name of the MNS queue.
attrQueueUrl	com.aliyun.ros.cdk.core.IResolvable	Attribute QueueUrl: The URL of the queue.
attrVisibilityTimeout	com.aliyun.ros.cdk.core.IResolvable	Attribute VisibilityTimeout: The duration for which a message stays in the Inactive state after it is consumed from the queue.

---

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

---

attrActiveMessages^Required

public IResolvable getAttrActiveMessages();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ActiveMessages: The total number of active messages in the queue.

---

attrCreateTime^Required

public IResolvable getAttrCreateTime();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The time when the queue was created.

---

attrDelayMessages^Required

public IResolvable getAttrDelayMessages();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DelayMessages: The total number of delayed messages in the queue.

---

attrDelaySeconds^Required

public IResolvable getAttrDelaySeconds();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DelaySeconds: The delay time after which all messages that are sent to the queue can be consumed.

---

attrInactiveMessages^Required

public IResolvable getAttrInactiveMessages();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InactiveMessages: The total number of inactive messages in the queue.

---

attrLastModifyTime^Required

public IResolvable getAttrLastModifyTime();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute LastModifyTime: The most recent time when the queue was modified.

---

attrLoggingEnabled^Required

public IResolvable getAttrLoggingEnabled();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute LoggingEnabled: Specifies whether to enable the log management feature.

---

attrMaximumMessageSize^Required

public IResolvable getAttrMaximumMessageSize();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute MaximumMessageSize: The maximum size of a message that can be sent to the queue.

---

attrMessageRetentionPeriod^Required

public IResolvable getAttrMessageRetentionPeriod();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute MessageRetentionPeriod: The maximum lifetime of a message in the queue.

After the time that is specified by this parameter expires, the message is deleted, regardless of whether the message has been consumed.

---

attrPollingWaitSeconds^Required

public IResolvable getAttrPollingWaitSeconds();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PollingWaitSeconds: The maximum time period that a ReceiveMessage request can wait till a message is in the queue.

---

attrQueueInternalUrl^Required

public IResolvable getAttrQueueInternalUrl();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute QueueInternalUrl: The internal URL of the queue.

---

attrQueueName^Required

public IResolvable getAttrQueueName();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute QueueName: The name of the MNS queue.

---

attrQueueUrl^Required

public IResolvable getAttrQueueUrl();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute QueueUrl: The URL of the queue.

---

attrVisibilityTimeout^Required

public IResolvable getAttrVisibilityTimeout();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VisibilityTimeout: The duration for which a message stays in the Inactive state after it is consumed from the queue.

---