ProductTopic

This class encapsulates and extends the ROS resource type ALIYUN::IOT::ProductTopic, which is used to create a topic category for a specified product.

Initializers

import com.aliyun.ros.cdk.iot.ProductTopic;
ProductTopic.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .operation(java.lang.String)
    .operation(IResolvable)
    .productKey(java.lang.String)
    .productKey(IResolvable)
    .topicShortName(java.lang.String)
    .topicShortName(IResolvable)
//  .desc(java.lang.String)
//  .desc(IResolvable)
//  .iotInstanceId(java.lang.String)
//  .iotInstanceId(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.
operation	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property operation: Operation permissions of devices on the topic category.
productKey	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property productKey: The unique identifier of the product for which you want to create a topic category.
topicShortName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property topicShortName: The custom category hierarchy in the topic category.
desc	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property desc: The description of the topic category.
iotInstanceId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property iotInstanceId: Instance ID you purchased.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

operation^Required

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

Property operation: Operation permissions of devices on the topic category.

Value options: SUB: Subscribe. Devices can subscribe to the topics of this category. PUB: Publish. Devices can publish messages using the topics of this category. ALL: Subscribe and publish. Devices can subscribe to and publish messages to the topics of this category.

---

productKey^Required

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

Property productKey: The unique identifier of the product for which you want to create a topic category.

---

topicShortName^Required

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

Property topicShortName: The custom category hierarchy in the topic category.

By default, a topic category contains two system defined category hierarchies: productKey and ${deviceName}. Forward slashes (/) are used to delimit the topic hierarchies. The format of a topic category is productKey/${deviceName}/topicShortName. Note The name of each category hierarchy can contain English letters, digits, and underscores (_), and cannot be empty.

---

desc^Optional

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

Property desc: The description of the topic category.

You can enter a description with up to 100 characters.

---

iotInstanceId^Optional

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

Property iotInstanceId: Instance ID you purchased.

Public instances do not need pass this property.

---

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.iot.ProductTopic;
ProductTopic.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.
attrTopicId	com.aliyun.ros.cdk.core.IResolvable	Attribute TopicId: Topic ID.

---

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

---

attrTopicId^Required

public IResolvable getAttrTopicId();

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

Attribute TopicId: Topic ID.

---