Topic

This class encapsulates and extends the ROS resource type DATASOURCE::KAFKA::Topic, which is used to query the information about a topic.

Initializers

import com.aliyun.ros.cdk.kafka.datasource.Topic;
Topic.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
    .topic(java.lang.String)
    .topic(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: Resource id.
topic	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property topic: Topic Name.
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

---

instanceId^Required

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

Property instanceId: Resource id.

---

topic^Required

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

Property topic: Topic Name.

---

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.kafka.datasource.Topic;
Topic.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.
attrCompactTopic	com.aliyun.ros.cdk.core.IResolvable	Attribute CompactTopic: Can log merge.
attrCreateTime	com.aliyun.ros.cdk.core.IResolvable	Attribute CreateTime: Creation time.
attrInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute InstanceId: Resource id.
attrLocalTopic	com.aliyun.ros.cdk.core.IResolvable	Attribute LocalTopic: Whether to store locally.
attrPartitionNum	com.aliyun.ros.cdk.core.IResolvable	Attribute PartitionNum: Number of partitions.
attrRemark	com.aliyun.ros.cdk.core.IResolvable	Attribute Remark: Remarks.
attrStatusName	com.aliyun.ros.cdk.core.IResolvable	Attribute StatusName: Meaning of status value.
attrTags	com.aliyun.ros.cdk.core.IResolvable	Attribute Tags: The tag of the kafka console, which is used to group instance,topic, and consumption.
attrTopic	com.aliyun.ros.cdk.core.IResolvable	Attribute Topic: Topic Name.
attrTopicStatus	com.aliyun.ros.cdk.core.IResolvable	Attribute TopicStatus: The Topic status.

---

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

---

attrCompactTopic^Required

public IResolvable getAttrCompactTopic();

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

Attribute CompactTopic: Can log merge.

---

attrCreateTime^Required

public IResolvable getAttrCreateTime();

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

Attribute CreateTime: Creation time.

---

attrInstanceId^Required

public IResolvable getAttrInstanceId();

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

Attribute InstanceId: Resource id.

---

attrLocalTopic^Required

public IResolvable getAttrLocalTopic();

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

Attribute LocalTopic: Whether to store locally.

---

attrPartitionNum^Required

public IResolvable getAttrPartitionNum();

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

Attribute PartitionNum: Number of partitions.

---

attrRemark^Required

public IResolvable getAttrRemark();

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

Attribute Remark: Remarks.

---

attrStatusName^Required

public IResolvable getAttrStatusName();

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

Attribute StatusName: Meaning of status value.

---

attrTags^Required

public IResolvable getAttrTags();

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

Attribute Tags: The tag of the kafka console, which is used to group instance,topic, and consumption.

---

attrTopic^Required

public IResolvable getAttrTopic();

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

Attribute Topic: Topic Name.

---

attrTopicStatus^Required

public IResolvable getAttrTopicStatus();

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

Attribute TopicStatus: The Topic status.

---