Topic
This class encapsulates and extends the ROS resource type DATASOURCE::MNS::Topic
, which is used to query the information about a topic.
Initializers
import com.aliyun.ros.cdk.mns.datasource.Topic;
Topic.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.topicName(java.lang.String)
.topicName(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. |
topicName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property topicName: The name of the resource. |
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
topicName
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property topicName: The name of the resource.
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- 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.Topic;
Topic.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- 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. |
attrCreateTime |
com.aliyun.ros.cdk.core.IResolvable |
Attribute CreateTime: The time when the topic was created. |
attrLastModifyTime |
com.aliyun.ros.cdk.core.IResolvable |
Attribute LastModifyTime: The time when the topic was last modified. |
attrLoggingEnabled |
com.aliyun.ros.cdk.core.IResolvable |
Attribute LoggingEnabled: Indicates whether the log management feature is enabled for the topic. |
attrMaxMessageSize |
com.aliyun.ros.cdk.core.IResolvable |
Attribute MaxMessageSize: The maximum size of a message body that is sent to the topic. |
attrMessageCount |
com.aliyun.ros.cdk.core.IResolvable |
Attribute MessageCount: The number of messages in the topic. |
attrMessageRetentionPeriod |
com.aliyun.ros.cdk.core.IResolvable |
Attribute MessageRetentionPeriod: The retention period of the message in the topic. |
attrTopicInnerUrl |
com.aliyun.ros.cdk.core.IResolvable |
Attribute TopicInnerUrl: The internal URL of the topic. |
attrTopicName |
com.aliyun.ros.cdk.core.IResolvable |
Attribute TopicName: The name of the MNS topic. |
attrTopicUrl |
com.aliyun.ros.cdk.core.IResolvable |
Attribute TopicUrl: The URL of the topic. |
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
attrCreateTime
Required
public IResolvable getAttrCreateTime();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The time when the topic was created.
attrLastModifyTime
Required
public IResolvable getAttrLastModifyTime();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute LastModifyTime: The time when the topic was last modified.
attrLoggingEnabled
Required
public IResolvable getAttrLoggingEnabled();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute LoggingEnabled: Indicates whether the log management feature is enabled for the topic.
attrMaxMessageSize
Required
public IResolvable getAttrMaxMessageSize();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute MaxMessageSize: The maximum size of a message body that is sent to the topic.
attrMessageCount
Required
public IResolvable getAttrMessageCount();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute MessageCount: The number of messages in the topic.
attrMessageRetentionPeriod
Required
public IResolvable getAttrMessageRetentionPeriod();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute MessageRetentionPeriod: The retention period of the message in the topic.
attrTopicInnerUrl
Required
public IResolvable getAttrTopicInnerUrl();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute TopicInnerUrl: The internal URL of the topic.
attrTopicName
Required
public IResolvable getAttrTopicName();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute TopicName: The name of the MNS topic.
attrTopicUrl
Required
public IResolvable getAttrTopicUrl();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute TopicUrl: The URL of the topic.