Topic
- Implements: com.aliyun.ros.cdk.rocketmq5.datasource.ITopic
This class encapsulates and extends the ROS resource type DATASOURCE::ROCKETMQ5::Topic, which is used to query the information about a topic.
Initializers
import com.aliyun.ros.cdk.rocketmq5.datasource.Topic;
Topic.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.instanceId(java.lang.String)
.instanceId(IResolvable)
.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. |
instanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property instanceId: The ID of the instance to which the topic belongs. |
topicName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property topicName: The name of the topic. |
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. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
instanceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property instanceId: The ID of the instance to which the topic belongs.
topicNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property topicName: The name of the topic.
refreshOptionsOptional
- 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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
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.rocketmq5.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. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The time when the topic was created. |
attrInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceId: The ID of the RocketMQ instance. |
attrMessageType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute MessageType: The message type of the topic. |
attrRemark | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Remark: The remarks on the topic. |
attrStatus | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Status: The state of the topic. |
attrTopicName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute TopicName: The name of the topic. |
attrUpdateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute UpdateTime: The time when the topic was last updated. |
props | TopicProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.ros.cdk.core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The time when the topic was created.
attrInstanceIdRequired
public java.lang.Object getAttrInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceId: The ID of the RocketMQ instance.
attrMessageTypeRequired
public java.lang.Object getAttrMessageType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute MessageType: The message type of the topic.
attrRemarkRequired
public java.lang.Object getAttrRemark();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Remark: The remarks on the topic.
attrStatusRequired
public java.lang.Object getAttrStatus();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Status: The state of the topic.
attrTopicNameRequired
public java.lang.Object getAttrTopicName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute TopicName: The name of the topic.
attrUpdateTimeRequired
public java.lang.Object getAttrUpdateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute UpdateTime: The time when the topic was last updated.
propsRequired
public TopicProps getProps();
- Type: TopicProps